diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php index 80e9eb2d..7211fb82 100644 --- a/.php-cs-fixer.dist.php +++ b/.php-cs-fixer.dist.php @@ -7,253 +7,257 @@ use PhpCsFixer\Finder; use PhpCsFixer\Runner; $finder = new Finder()->in(__DIR__)->exclude([ - 'vendor', - 'web/vendor', - 'web/wp', - 'web/app/languages', - 'web/app/plugins', - 'web/app/mu-plugins', + 'vendor', + 'web/vendor', + 'web/wp', + 'web/app/languages', + 'web/app/plugins', + 'web/app/mu-plugins', ]); return new Config() - ->setRiskyAllowed(true) - ->setRules([ - 'array_syntax' => ['syntax' => 'short'], - 'assign_null_coalescing_to_coalesce_equal' => true, - 'attribute_empty_parentheses' => ['use_parentheses' => true], - 'blank_line_after_namespace' => true, - 'blank_lines_before_namespace' => ['min_line_breaks' => 1, 'max_line_breaks' => 2], - 'cast_spaces' => true, - 'class_attributes_separation' => ['elements' => [ - 'case' => 'none', - 'const' => 'none', - 'method' => 'one', - 'property' => 'one', - 'trait_import' => 'none', - ]], - 'class_reference_name_casing' => true, - 'clean_namespace' => true, - 'combine_consecutive_issets' => true, - 'combine_consecutive_unsets' => true, - 'combine_nested_dirname' => true, - 'comment_to_phpdoc' => true, - 'constant_case' => true, - 'date_time_immutable' => true, - 'declare_equal_normalize' => true, - 'declare_parentheses' => true, - 'declare_strict_types' => true, - 'dir_constant' => true, - 'echo_tag_syntax' => true, - 'encoding' => true, - 'ereg_to_preg' => true, - 'error_suppression' => true, - 'explicit_indirect_variable' => true, - 'explicit_string_variable' => true, - 'final_class' => true, - 'final_internal_class' => true, - 'full_opening_tag' => true, - 'fully_qualified_strict_types' => ['import_symbols' => true], - 'function_to_constant' => true, - 'global_namespace_import' => ['import_classes' => true, 'import_constants' => true, 'import_functions' => true], - 'heredoc_to_nowdoc' => true, - 'integer_literal_case' => true, - 'lambda_not_used_import' => true, - 'list_syntax' => true, - 'logical_operators' => true, - 'long_to_shorthand_operator' => true, - 'lowercase_cast' => true, - 'lowercase_keywords' => true, - 'lowercase_static_reference' => true, - 'magic_constant_casing' => true, - 'magic_method_casing' => true, - 'mb_str_functions' => true, - 'modernize_strpos' => ['modernize_stripos' => true], - 'modernize_types_casting' => true, - 'modifier_keywords' => true, - 'multiline_comment_opening_closing' => true, - 'native_constant_invocation' => true, - 'native_function_casing' => true, - 'native_function_invocation' => ['include' => ['@compiler_optimized'], 'scope' => 'namespaced', 'strict' => true], - 'native_type_declaration_casing' => true, - 'new_expression_parentheses' => true, - 'no_alias_functions' => ['sets' => ['@all']], - 'no_alias_language_construct_call' => true, - 'no_alternative_syntax' => true, - 'no_binary_string' => true, - 'no_closing_tag' => true, - 'no_empty_comment' => true, - 'no_homoglyph_names' => true, - 'no_leading_import_slash' => true, - 'no_mixed_echo_print' => ['use' => 'echo'], - 'no_multiline_whitespace_around_double_arrow' => true, - 'no_multiple_statements_per_line' => true, - 'no_null_property_initialization' => true, - 'no_php4_constructor' => true, - 'no_short_bool_cast' => true, - 'no_trailing_comma_in_singleline' => true, - 'no_trailing_whitespace_in_comment' => true, - 'no_unneeded_braces' => ['namespaces' => true], - 'no_unneeded_control_parentheses' => ['statements' => [ - 'break', - 'clone', - 'continue', - 'echo_print', - 'negative_instanceof', - 'others', - 'return', - 'switch_case', - 'yield', - 'yield_from', - ]], - 'no_unneeded_final_method' => true, - 'no_unneeded_import_alias' => true, - 'no_unreachable_default_argument_value' => true, - 'no_unset_cast' => true, - 'no_unset_on_property' => true, - 'no_unused_imports' => true, - 'no_useless_concat_operator' => true, - 'no_useless_nullsafe_operator' => true, - 'no_useless_printf' => true, - 'no_useless_return' => true, - 'no_useless_sprintf' => true, - 'no_whitespace_before_comma_in_array' => ['after_heredoc' => true], - 'non_printable_character' => true, - 'normalize_index_brace' => true, - 'nullable_type_declaration' => ['syntax' => 'union'], - 'nullable_type_declaration_for_default_null_value' => true, - 'numeric_literal_separator' => ['override_existing' => true, 'strategy' => 'use_separator'], - 'ordered_attributes' => true, - 'ordered_class_elements' => ['case_sensitive' => false, 'sort_algorithm' => 'alpha'], - 'ordered_imports' => ['case_sensitive' => true], - 'ordered_interfaces' => true, - 'ordered_traits' => true, - 'ordered_types' => ['null_adjustment' => 'always_last'], - 'phpdoc_readonly_class_comment_to_keyword' => true, - 'phpdoc_to_param_type' => true, - 'phpdoc_to_property_type' => true, - 'phpdoc_to_return_type' => true, - 'pow_to_exponentiation' => true, - 'protected_to_private' => true, - 'psr_autoloading' => true, - 'random_api_migration' => ['replacements' => [ - 'getrandmax' => 'mt_getrandmax', - 'rand' => 'mt_rand', - 'srand' => 'mt_srand', - ]], - 'return_assignment' => true, - 'self_accessor' => true, - 'self_static_accessor' => true, - 'set_type_to_cast' => true, - 'short_scalar_cast' => true, - 'simple_to_complex_string_variable' => true, - 'simplified_null_return' => true, - 'single_class_element_per_statement' => true, - 'single_import_per_statement' => true, - 'single_line_after_imports' => true, - 'single_line_comment_spacing' => true, - 'single_line_comment_style' => true, - 'single_line_empty_body' => true, - 'single_trait_insert_per_statement' => true, - 'standardize_not_equals' => true, - 'static_lambda' => true, - 'strict_comparison' => true, - 'strict_param' => true, - 'string_implicit_backslashes' => true, - 'string_length_to_empty' => true, - 'switch_continue_to_break' => true, - 'ternary_to_null_coalescing' => true, - 'trim_array_spaces' => true, - 'use_arrow_functions' => true, - 'void_return' => true, - 'whitespace_after_comma_in_array' => ['ensure_single_space' => true], - // --- - // Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one. - 'align_multiline_comment' => ['comment_type' => 'all_multiline'], - // There should not be blank lines between docblock and the documented element. - 'no_blank_lines_after_phpdoc' => true, - // There should not be empty PHPDoc blocks. - 'no_empty_phpdoc' => true, - // Removes @param, @return and @var tags that don't provide any useful information. - 'no_superfluous_phpdoc_tags' => [ - 'allow_hidden_params' => false, - 'allow_mixed' => false, - 'allow_unused_params' => false, - ], - // PHPDoc should contain @param for all params. - 'phpdoc_add_missing_param_annotation' => ['only_untyped' => false], - // All items of the given PHPDoc tags must be either left-aligned or (by default) aligned vertically. - 'phpdoc_align' => true, - // PHPDoc annotation descriptions should not be a sentence. - 'phpdoc_annotation_without_dot' => true, - // PHPDoc array type must be used instead of T[]. - 'phpdoc_array_type' => true, - // Docblocks should have the same indentation as the documented subject. - 'phpdoc_indent' => true, - // Fixes PHPDoc inline tags. - 'phpdoc_inline_tag_normalizer' => true, - // Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only. - 'phpdoc_line_span' => ['const' => 'single', 'method' => 'multi', 'property' => 'single'], - // PHPDoc list type must be used instead of array without a key. - 'phpdoc_list_type' => false, - // @access annotations must be removed from PHPDoc. - 'phpdoc_no_access' => true, - // No alias PHPDoc tags should be used. - 'phpdoc_no_alias_tag' => true, - // @return void and @return null annotations must be removed from PHPDoc. - 'phpdoc_no_empty_return' => false, - // @package and @subpackage annotations must be removed from PHPDoc. - 'phpdoc_no_package' => true, - // Classy that does not inherit must not have @inheritdoc tags. - 'phpdoc_no_useless_inheritdoc' => true, - // Annotations in PHPDoc should be ordered in defined sequence. - 'phpdoc_order' => true, - // Order PHPDoc tags by value. - 'phpdoc_order_by_value' => true, - // Orders all @param annotations in DocBlocks according to method signature. - 'phpdoc_param_order' => true, - // The type of @return annotations of methods returning a reference to itself must the configured one. - 'phpdoc_return_self_reference' => true, - // Scalar types should always be written in the same form. int not integer, bool not boolean, float not real or double. - 'phpdoc_scalar' => ['types' => [ - 'boolean', - 'callback', - 'double', - 'integer', - 'never-return', - 'never-returns', - 'no-return', - 'real', - 'str', - ]], - // Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line. - 'phpdoc_separation' => [ - 'groups' => [ - ['Annotation', 'NamedArgumentConstructor', 'Target'], - ['author', 'copyright', 'license'], - ['category', 'package', 'subpackage'], - ['property', 'property-read', 'property-write'], - ['deprecated', 'link', 'see', 'since'], - ], - 'skip_unlisted_annotations' => false, - ], - // Single line @var PHPDoc should have proper spacing. - 'phpdoc_single_line_var_spacing' => true, - // PHPDoc summary should end in either a full stop, exclamation mark, or question mark. - 'phpdoc_summary' => true, - // Docblocks should only be used on structural elements. - 'phpdoc_to_comment' => false, - // PHPDoc should start and end with content, excluding the very first and last line of the docblocks. - 'phpdoc_trim' => true, - // Removes extra blank lines after summary and after description in PHPDoc. - 'phpdoc_trim_consecutive_blank_line_separation' => true, - // The correct case must be used for standard PHP types in PHPDoc. - 'phpdoc_types' => true, - // Sorts PHPDoc types. - 'phpdoc_types_order' => ['null_adjustment' => 'always_last'], - // @var and @type annotations must have type and name in the correct order. - 'phpdoc_var_annotation_correct_order' => true, - // @var and @type annotations of classy properties should not contain the name. - 'phpdoc_var_without_name' => true, - ]) - ->setFinder($finder) - ->setParallelConfig(Runner\Parallel\ParallelConfigFactory::detect()); + ->setRiskyAllowed(true) + ->setRules([ + 'array_syntax' => ['syntax' => 'short'], + 'assign_null_coalescing_to_coalesce_equal' => true, + 'attribute_empty_parentheses' => ['use_parentheses' => true], + 'blank_line_after_namespace' => true, + 'blank_lines_before_namespace' => ['min_line_breaks' => 1, 'max_line_breaks' => 2], + 'cast_spaces' => true, + 'class_attributes_separation' => ['elements' => [ + 'case' => 'none', + 'const' => 'none', + 'method' => 'one', + 'property' => 'one', + 'trait_import' => 'none', + ]], + 'class_reference_name_casing' => true, + 'clean_namespace' => true, + 'combine_consecutive_issets' => true, + 'combine_consecutive_unsets' => true, + 'combine_nested_dirname' => true, + 'comment_to_phpdoc' => true, + 'constant_case' => true, + 'date_time_immutable' => true, + 'declare_equal_normalize' => true, + 'declare_parentheses' => true, + 'declare_strict_types' => true, + 'dir_constant' => true, + 'echo_tag_syntax' => true, + 'encoding' => true, + 'ereg_to_preg' => true, + 'error_suppression' => true, + 'explicit_indirect_variable' => true, + 'explicit_string_variable' => true, + 'final_class' => true, + 'final_internal_class' => true, + 'full_opening_tag' => true, + 'fully_qualified_strict_types' => ['import_symbols' => true], + 'function_to_constant' => true, + 'global_namespace_import' => ['import_classes' => true, 'import_constants' => true, 'import_functions' => true], + 'heredoc_to_nowdoc' => true, + 'integer_literal_case' => true, + 'lambda_not_used_import' => true, + 'list_syntax' => true, + 'logical_operators' => true, + 'long_to_shorthand_operator' => true, + 'lowercase_cast' => true, + 'lowercase_keywords' => true, + 'lowercase_static_reference' => true, + 'magic_constant_casing' => true, + 'magic_method_casing' => true, + 'mb_str_functions' => true, + 'modernize_strpos' => ['modernize_stripos' => true], + 'modernize_types_casting' => true, + 'modifier_keywords' => true, + 'multiline_comment_opening_closing' => true, + 'native_constant_invocation' => true, + 'native_function_casing' => true, + 'native_function_invocation' => [ + 'include' => ['@compiler_optimized'], + 'scope' => 'namespaced', + 'strict' => true, + ], + 'native_type_declaration_casing' => true, + 'new_expression_parentheses' => true, + 'no_alias_functions' => ['sets' => ['@all']], + 'no_alias_language_construct_call' => true, + 'no_alternative_syntax' => true, + 'no_binary_string' => true, + 'no_closing_tag' => true, + 'no_empty_comment' => true, + 'no_homoglyph_names' => true, + 'no_leading_import_slash' => true, + 'no_mixed_echo_print' => ['use' => 'echo'], + 'no_multiline_whitespace_around_double_arrow' => true, + 'no_multiple_statements_per_line' => true, + 'no_null_property_initialization' => true, + 'no_php4_constructor' => true, + 'no_short_bool_cast' => true, + 'no_trailing_comma_in_singleline' => true, + 'no_trailing_whitespace_in_comment' => true, + 'no_unneeded_braces' => ['namespaces' => true], + 'no_unneeded_control_parentheses' => ['statements' => [ + 'break', + 'clone', + 'continue', + 'echo_print', + 'negative_instanceof', + 'others', + 'return', + 'switch_case', + 'yield', + 'yield_from', + ]], + 'no_unneeded_final_method' => true, + 'no_unneeded_import_alias' => true, + 'no_unreachable_default_argument_value' => true, + 'no_unset_cast' => true, + 'no_unset_on_property' => true, + 'no_unused_imports' => true, + 'no_useless_concat_operator' => true, + 'no_useless_nullsafe_operator' => true, + 'no_useless_printf' => true, + 'no_useless_return' => true, + 'no_useless_sprintf' => true, + 'no_whitespace_before_comma_in_array' => ['after_heredoc' => true], + 'non_printable_character' => true, + 'normalize_index_brace' => true, + 'nullable_type_declaration' => ['syntax' => 'union'], + 'nullable_type_declaration_for_default_null_value' => true, + 'numeric_literal_separator' => ['override_existing' => true, 'strategy' => 'use_separator'], + 'ordered_attributes' => true, + 'ordered_class_elements' => ['case_sensitive' => false, 'sort_algorithm' => 'alpha'], + 'ordered_imports' => ['case_sensitive' => true], + 'ordered_interfaces' => true, + 'ordered_traits' => true, + 'ordered_types' => ['null_adjustment' => 'always_last'], + 'phpdoc_readonly_class_comment_to_keyword' => true, + 'phpdoc_to_param_type' => true, + 'phpdoc_to_property_type' => true, + 'phpdoc_to_return_type' => true, + 'pow_to_exponentiation' => true, + 'protected_to_private' => true, + 'psr_autoloading' => true, + 'random_api_migration' => ['replacements' => [ + 'getrandmax' => 'mt_getrandmax', + 'rand' => 'mt_rand', + 'srand' => 'mt_srand', + ]], + 'return_assignment' => true, + 'self_accessor' => true, + 'self_static_accessor' => true, + 'set_type_to_cast' => true, + 'short_scalar_cast' => true, + 'simple_to_complex_string_variable' => true, + 'simplified_null_return' => true, + 'single_class_element_per_statement' => true, + 'single_import_per_statement' => true, + 'single_line_after_imports' => true, + 'single_line_comment_spacing' => true, + 'single_line_comment_style' => true, + 'single_line_empty_body' => true, + 'single_trait_insert_per_statement' => true, + 'standardize_not_equals' => true, + 'static_lambda' => true, + 'strict_comparison' => true, + 'strict_param' => true, + 'string_implicit_backslashes' => true, + 'string_length_to_empty' => true, + 'switch_continue_to_break' => true, + 'ternary_to_null_coalescing' => true, + 'trim_array_spaces' => true, + 'use_arrow_functions' => true, + 'void_return' => true, + 'whitespace_after_comma_in_array' => ['ensure_single_space' => true], + // --- + // Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one. + 'align_multiline_comment' => ['comment_type' => 'all_multiline'], + // There should not be blank lines between docblock and the documented element. + 'no_blank_lines_after_phpdoc' => true, + // There should not be empty PHPDoc blocks. + 'no_empty_phpdoc' => true, + // Removes @param, @return and @var tags that don't provide any useful information. + 'no_superfluous_phpdoc_tags' => [ + 'allow_hidden_params' => false, + 'allow_mixed' => false, + 'allow_unused_params' => false, + ], + // PHPDoc should contain @param for all params. + 'phpdoc_add_missing_param_annotation' => ['only_untyped' => false], + // All items of the given PHPDoc tags must be either left-aligned or (by default) aligned vertically. + 'phpdoc_align' => true, + // PHPDoc annotation descriptions should not be a sentence. + 'phpdoc_annotation_without_dot' => true, + // PHPDoc array type must be used instead of T[]. + 'phpdoc_array_type' => true, + // Docblocks should have the same indentation as the documented subject. + 'phpdoc_indent' => true, + // Fixes PHPDoc inline tags. + 'phpdoc_inline_tag_normalizer' => true, + // Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only. + 'phpdoc_line_span' => ['const' => 'single', 'method' => 'multi', 'property' => 'single'], + // PHPDoc list type must be used instead of array without a key. + 'phpdoc_list_type' => false, + // @access annotations must be removed from PHPDoc. + 'phpdoc_no_access' => true, + // No alias PHPDoc tags should be used. + 'phpdoc_no_alias_tag' => true, + // @return void and @return null annotations must be removed from PHPDoc. + 'phpdoc_no_empty_return' => false, + // @package and @subpackage annotations must be removed from PHPDoc. + 'phpdoc_no_package' => true, + // Classy that does not inherit must not have @inheritdoc tags. + 'phpdoc_no_useless_inheritdoc' => true, + // Annotations in PHPDoc should be ordered in defined sequence. + 'phpdoc_order' => true, + // Order PHPDoc tags by value. + 'phpdoc_order_by_value' => true, + // Orders all @param annotations in DocBlocks according to method signature. + 'phpdoc_param_order' => true, + // The type of @return annotations of methods returning a reference to itself must the configured one. + 'phpdoc_return_self_reference' => true, + // Scalar types should always be written in the same form. int not integer, bool not boolean, float not real or double. + 'phpdoc_scalar' => ['types' => [ + 'boolean', + 'callback', + 'double', + 'integer', + 'never-return', + 'never-returns', + 'no-return', + 'real', + 'str', + ]], + // Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line. + 'phpdoc_separation' => [ + 'groups' => [ + ['Annotation', 'NamedArgumentConstructor', 'Target'], + ['author', 'copyright', 'license'], + ['category', 'package', 'subpackage'], + ['property', 'property-read', 'property-write'], + ['deprecated', 'link', 'see', 'since'], + ], + 'skip_unlisted_annotations' => false, + ], + // Single line @var PHPDoc should have proper spacing. + 'phpdoc_single_line_var_spacing' => true, + // PHPDoc summary should end in either a full stop, exclamation mark, or question mark. + 'phpdoc_summary' => true, + // Docblocks should only be used on structural elements. + 'phpdoc_to_comment' => false, + // PHPDoc should start and end with content, excluding the very first and last line of the docblocks. + 'phpdoc_trim' => true, + // Removes extra blank lines after summary and after description in PHPDoc. + 'phpdoc_trim_consecutive_blank_line_separation' => true, + // The correct case must be used for standard PHP types in PHPDoc. + 'phpdoc_types' => true, + // Sorts PHPDoc types. + 'phpdoc_types_order' => ['null_adjustment' => 'always_last'], + // @var and @type annotations must have type and name in the correct order. + 'phpdoc_var_annotation_correct_order' => true, + // @var and @type annotations of classy properties should not contain the name. + 'phpdoc_var_without_name' => true, + ]) + ->setFinder($finder) + ->setParallelConfig(Runner\Parallel\ParallelConfigFactory::detect()); diff --git a/.phpactor.json b/.phpactor.json index 05f1edd9..d068e282 100755 --- a/.phpactor.json +++ b/.phpactor.json @@ -1,9 +1,9 @@ { "$schema": "./phpactor.schema.json", "indexer.exclude_patterns": [ - "/vendor/**/Tests/**/*", - "/vendor/**/tests/**/*", "/var/cache/**/*", + "/vendor/**/tests/**/*", + "/vendor/**/Tests/**/*", "/vendor/composer/**/*" ], "language_server.diagnostic_outsource_timeout": 5, diff --git a/.zed/settings.json b/.zed/settings.json index 1c6babec..fd002a27 100644 --- a/.zed/settings.json +++ b/.zed/settings.json @@ -15,9 +15,9 @@ "initialization_options": { "settings": { "configPath": "cfg/oxlint.config.ts", - "run": "onType", "disableNestedConfig": false, "fixKind": "safe_fix", + "run": "onType", "unusedDisableDirectives": "deny" } } diff --git a/bun.lock b/bun.lock index b9f4e297..a471fd0e 100644 --- a/bun.lock +++ b/bun.lock @@ -15,7 +15,7 @@ "valibot": "1.1.0", }, "devDependencies": { - "@effect/language-service": "^0.84.3", + "@effect/language-service": "^0.85.0", "@gcch/configuration-eslint": "git+https://git.gcch.fr/gcch/configuration-eslint#62ee424274", "@gcch/configuration-oxlint": "git+https://git.gcch.fr/gcch/configuration-oxlint#0968f683", "@gcch/configuration-prettier": "git+https://git.gcch.fr/gcch/configuration-prettier#8de937e801", @@ -54,7 +54,7 @@ "stylelint-plugin-logical-css": "^2.1.0", "typescript": "6.0.2", "typescript-eslint": "^8.58.1", - "vite": "^8.0.7", + "vite": "^8.0.8", "vite-tsconfig-paths": "^6.1.1", }, }, @@ -266,13 +266,13 @@ "@csstools/selector-specificity": ["@csstools/selector-specificity@6.0.0", "", { "peerDependencies": { "postcss-selector-parser": "^7.1.1" } }, "sha512-4sSgl78OtOXEX/2d++8A83zHNTgwCJMaR24FvsYL7Uf/VS8HZk9PTwR51elTbGqMuwH3szLvvOXEaVnqn0Z3zA=="], - "@effect/language-service": ["@effect/language-service@0.84.3", "", { "bin": { "effect-language-service": "cli.js" } }, "sha512-zpxi6rLCwst/cBQd7ElwDvt36Y6Jvz8v6bCLnNiOL6OXvdLmqjOFWyzWZdMh92vvBQA/aVKhfIAAOP3o4wKt0A=="], + "@effect/language-service": ["@effect/language-service@0.85.1", "", { "bin": { "effect-language-service": "cli.js" } }, "sha512-EXnJjIy6zQ3nUO/MZ+ynWUb8B895KZPotd1++oTs9JjDkplwM7cb6zo8Zq2zU6piwq+KflO7amXbEfj1UMpHkw=="], - "@emnapi/core": ["@emnapi/core@1.9.1", "", { "dependencies": { "@emnapi/wasi-threads": "1.2.0", "tslib": "^2.4.0" } }, "sha512-mukuNALVsoix/w1BJwFzwXBN/dHeejQtuVzcDsfOEsdpCumXb/E9j8w11h5S54tT1xhifGfbbSm/ICrObRb3KA=="], + "@emnapi/core": ["@emnapi/core@1.9.2", "", { "dependencies": { "@emnapi/wasi-threads": "1.2.1", "tslib": "^2.4.0" } }, "sha512-UC+ZhH3XtczQYfOlu3lNEkdW/p4dsJ1r/bP7H8+rhao3TTTMO1ATq/4DdIi23XuGoFY+Cz0JmCbdVl0hz9jZcA=="], - "@emnapi/runtime": ["@emnapi/runtime@1.9.1", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-VYi5+ZVLhpgK4hQ0TAjiQiZ6ol0oe4mBx7mVv7IflsiEp0OWoVsp/+f9Vc1hOhE0TtkORVrI1GvzyreqpgWtkA=="], + "@emnapi/runtime": ["@emnapi/runtime@1.9.2", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-3U4+MIWHImeyu1wnmVygh5WlgfYDtyf0k8AbLhMFxOipihf6nrWC4syIm/SwEeec0mNSafiiNnMJwbza/Is6Lw=="], - "@emnapi/wasi-threads": ["@emnapi/wasi-threads@1.2.0", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-N10dEJNSsUx41Z6pZsXU8FjPjpBEplgH24sfkmITrBED1/U2Esum9F3lfLrMjKHHjmi557zQn7kR9R+XWXu5Rg=="], + "@emnapi/wasi-threads": ["@emnapi/wasi-threads@1.2.1", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-uTII7OYF+/Mes/MrcIOYp5yOtSMLBWSIoLPpcgwipoiKbli6k322tcoFsxoIIxPDqW01SQGAgko4EzZi2BNv2w=="], "@es-joy/jsdoccomment": ["@es-joy/jsdoccomment@0.86.0", "", { "dependencies": { "@types/estree": "^1.0.8", "@typescript-eslint/types": "^8.58.0", "comment-parser": "1.4.6", "esquery": "^1.7.0", "jsdoc-type-pratt-parser": "~7.2.0" } }, "sha512-ukZmRQ81WiTpDWO6D/cTBM7XbrNtutHKvAVnZN/8pldAwLoJArGOvkNyxPTBGsPjsoaQBJxlH+tE2TNA/92Qgw=="], @@ -282,17 +282,17 @@ "@eslint-community/regexpp": ["@eslint-community/regexpp@4.12.2", "", {}, "sha512-EriSTlt5OC9/7SXkRSCAhfSxxoSUgBm33OH+IkwbdpgoqsSsUg7y3uh+IICI/Qg4BBWr3U2i39RpmycbxMq4ew=="], - "@eslint/config-array": ["@eslint/config-array@0.23.4", "", { "dependencies": { "@eslint/object-schema": "^3.0.4", "debug": "^4.3.1", "minimatch": "^10.2.4" } }, "sha512-lf19F24LSMfF8weXvW5QEtnLqW70u7kgit5e9PSx0MsHAFclGd1T9ynvWEMDT1w5J4Qt54tomGeAhdoAku1Xow=="], + "@eslint/config-array": ["@eslint/config-array@0.23.5", "", { "dependencies": { "@eslint/object-schema": "^3.0.5", "debug": "^4.3.1", "minimatch": "^10.2.4" } }, "sha512-Y3kKLvC1dvTOT+oGlqNQ1XLqK6D1HU2YXPc52NmAlJZbMMWDzGYXMiPRJ8TYD39muD/OTjlZmNJ4ib7dvSrMBA=="], - "@eslint/config-helpers": ["@eslint/config-helpers@0.5.4", "", { "dependencies": { "@eslint/core": "^1.2.0" } }, "sha512-jJhqiY3wPMlWWO3370M86CPJ7pt8GmEwSLglMfQhjXal07RCvhmU0as4IuUEW5SJeunfItiEetHmSxCCe9lDBg=="], + "@eslint/config-helpers": ["@eslint/config-helpers@0.5.5", "", { "dependencies": { "@eslint/core": "^1.2.1" } }, "sha512-eIJYKTCECbP/nsKaaruF6LW967mtbQbsw4JTtSVkUQc9MneSkbrgPJAbKl9nWr0ZeowV8BfsarBmPpBzGelA2w=="], - "@eslint/core": ["@eslint/core@1.2.0", "", { "dependencies": { "@types/json-schema": "^7.0.15" } }, "sha512-8FTGbNzTvmSlc4cZBaShkC6YvFMG0riksYWRFKXztqVdXaQbcZLXlFbSpC05s70sGEsXAw0qwhx69JiW7hQS7A=="], + "@eslint/core": ["@eslint/core@1.2.1", "", { "dependencies": { "@types/json-schema": "^7.0.15" } }, "sha512-MwcE1P+AZ4C6DWlpin/OmOA54mmIZ/+xZuJiQd4SyB29oAJjN30UW9wkKNptW2ctp4cEsvhlLY/CsQ1uoHDloQ=="], "@eslint/js": ["@eslint/js@10.0.1", "", { "peerDependencies": { "eslint": "^10.0.0" }, "optionalPeers": ["eslint"] }, "sha512-zeR9k5pd4gxjZ0abRoIaxdc7I3nDktoXZk2qOv9gCNWx3mVwEn32VRhyLaRsDiJjTs0xq/T8mfPtyuXu7GWBcA=="], - "@eslint/object-schema": ["@eslint/object-schema@3.0.4", "", {}, "sha512-55lO/7+Yp0ISKRP0PsPtNTeNGapXaO085aELZmWCVc5SH3jfrqpuU6YgOdIxMS99ZHkQN1cXKE+cdIqwww9ptw=="], + "@eslint/object-schema": ["@eslint/object-schema@3.0.5", "", {}, "sha512-vqTaUEgxzm+YDSdElad6PiRoX4t8VGDjCtt05zn4nU810UIx/uNEV7/lZJ6KwFThKZOzOxzXy48da+No7HZaMw=="], - "@eslint/plugin-kit": ["@eslint/plugin-kit@0.7.0", "", { "dependencies": { "@eslint/core": "^1.2.0", "levn": "^0.4.1" } }, "sha512-ejvBr8MQCbVsWNZnCwDXjUKq40MDmHalq7cJ6e9s/qzTUFIIo/afzt1Vui9T97FM/V/pN4YsFVoed5NIa96RDg=="], + "@eslint/plugin-kit": ["@eslint/plugin-kit@0.7.1", "", { "dependencies": { "@eslint/core": "^1.2.1", "levn": "^0.4.1" } }, "sha512-rZAP3aVgB9ds9KOeUSL+zZ21hPmo8dh6fnIFwRQj5EAZl9gzR7wxYbYXYysAM8CTqGmUGyp2S4kUdV17MnGuWQ=="], "@gcch/configuration-eslint": ["@gcch/configuration-eslint@git+https://git.gcch.fr/gcch/configuration-eslint#62ee424274f0bfebd5135a728960644f4b1cdcb8", { "dependencies": { "@eslint/js": "^10.0.1", "astro-eslint-parser": "^1.3.0", "eslint": "^10.0.3", "eslint-plugin-astro": "^1.6.0", "eslint-plugin-functional": "^9.0.4", "eslint-plugin-jsdoc": "^62.8.0", "eslint-plugin-jsx-a11y": "^6.10.2", "eslint-plugin-perfectionist": "^5.6.0", "eslint-plugin-sonarjs": "^4.0.2", "eslint-plugin-unicorn": "^63.0.0", "globals": "^17.4.0", "typescript-eslint": "^8.57.0" }, "peerDependencies": { "eslint": "^10.0.3", "typescript": "^6.0.1-rc" } }, "62ee424274f0bfebd5135a728960644f4b1cdcb8"], @@ -338,7 +338,7 @@ "@msgpackr-extract/msgpackr-extract-win32-x64": ["@msgpackr-extract/msgpackr-extract-win32-x64@3.0.3", "", { "os": "win32", "cpu": "x64" }, "sha512-x0fWaQtYp4E6sktbsdAqnehxDgEc/VwM7uLsRCYWaiGu0ykYdZPiS8zCWdnjHwyiumousxfBm4SO31eXqwEZhQ=="], - "@napi-rs/wasm-runtime": ["@napi-rs/wasm-runtime@1.1.2", "", { "dependencies": { "@tybys/wasm-util": "^0.10.1" }, "peerDependencies": { "@emnapi/core": "^1.7.1", "@emnapi/runtime": "^1.7.1" } }, "sha512-sNXv5oLJ7ob93xkZ1XnxisYhGYXfaG9f65/ZgYuAu3qt7b3NadcOEhLvx28hv31PgX8SZJRYrAIPQilQmFpLVw=="], + "@napi-rs/wasm-runtime": ["@napi-rs/wasm-runtime@1.1.3", "", { "dependencies": { "@tybys/wasm-util": "^0.10.1" }, "peerDependencies": { "@emnapi/core": "^1.7.1", "@emnapi/runtime": "^1.7.1" } }, "sha512-xK9sGVbJWYb08+mTJt3/YV24WxvxpXcXtP6B172paPZ+Ts69Re9dAr7lKwJoeIx8OoeuimEiRZ7umkiUVClmmQ=="], "@nodelib/fs.scandir": ["@nodelib/fs.scandir@2.1.5", "", { "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" } }, "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g=="], @@ -512,49 +512,49 @@ "@reteps/dockerfmt": ["@reteps/dockerfmt@0.5.2", "", {}, "sha512-Hbr7yen4fP5TxGM54ucXa4o5NwWXatJ6Bd9I8gp0PValYbI4Rug2Gu+rVv7K7o/efQc3F5ctqWJz47rYaa8zBw=="], - "@rolldown/binding-android-arm64": ["@rolldown/binding-android-arm64@1.0.0-rc.13", "", { "os": "android", "cpu": "arm64" }, "sha512-5ZiiecKH2DXAVJTNN13gNMUcCDg4Jy8ZjbXEsPnqa248wgOVeYRX0iqXXD5Jz4bI9BFHgKsI2qmyJynstbmr+g=="], + "@rolldown/binding-android-arm64": ["@rolldown/binding-android-arm64@1.0.0-rc.15", "", { "os": "android", "cpu": "arm64" }, "sha512-YYe6aWruPZDtHNpwu7+qAHEMbQ/yRl6atqb/AhznLTnD3UY99Q1jE7ihLSahNWkF4EqRPVC4SiR4O0UkLK02tA=="], - "@rolldown/binding-darwin-arm64": ["@rolldown/binding-darwin-arm64@1.0.0-rc.13", "", { "os": "darwin", "cpu": "arm64" }, "sha512-tz/v/8G77seu8zAB3A5sK3UFoOl06zcshEzhUO62sAEtrEuW/H1CcyoupOrD+NbQJytYgA4CppXPzlrmp4JZKA=="], + "@rolldown/binding-darwin-arm64": ["@rolldown/binding-darwin-arm64@1.0.0-rc.15", "", { "os": "darwin", "cpu": "arm64" }, "sha512-oArR/ig8wNTPYsXL+Mzhs0oxhxfuHRfG7Ikw7jXsw8mYOtk71W0OkF2VEVh699pdmzjPQsTjlD1JIOoHkLP1Fg=="], - "@rolldown/binding-darwin-x64": ["@rolldown/binding-darwin-x64@1.0.0-rc.13", "", { "os": "darwin", "cpu": "x64" }, "sha512-8DakphqOz8JrMYWTJmWA+vDJxut6LijZ8Xcdc4flOlAhU7PNVwo2MaWBF9iXjJAPo5rC/IxEFZDhJ3GC7NHvug=="], + "@rolldown/binding-darwin-x64": ["@rolldown/binding-darwin-x64@1.0.0-rc.15", "", { "os": "darwin", "cpu": "x64" }, "sha512-YzeVqOqjPYvUbJSWJ4EDL8ahbmsIXQpgL3JVipmN+MX0XnXMeWomLN3Fb+nwCmP/jfyqte5I3XRSm7OfQrbyxw=="], - "@rolldown/binding-freebsd-x64": ["@rolldown/binding-freebsd-x64@1.0.0-rc.13", "", { "os": "freebsd", "cpu": "x64" }, "sha512-4wBQFfjDuXYN/SVI8inBF3Aa+isq40rc6VMFbk5jcpolUBTe5cYnMsHZ51nFWsx3PVyyNN3vgoESki0Hmr/4BA=="], + "@rolldown/binding-freebsd-x64": ["@rolldown/binding-freebsd-x64@1.0.0-rc.15", "", { "os": "freebsd", "cpu": "x64" }, "sha512-9Erhx956jeQ0nNTyif1+QWAXDRD38ZNjr//bSHrt6wDwB+QkAfl2q6Mn1k6OBPerznjRmbM10lgRb1Pli4xZPw=="], - "@rolldown/binding-linux-arm-gnueabihf": ["@rolldown/binding-linux-arm-gnueabihf@1.0.0-rc.13", "", { "os": "linux", "cpu": "arm" }, "sha512-JW/e4yPIXLms+jmnbwwy5LA/LxVwZUWLN8xug+V200wzaVi5TEGIWQlh8o91gWYFxW609euI98OCCemmWGuPrw=="], + "@rolldown/binding-linux-arm-gnueabihf": ["@rolldown/binding-linux-arm-gnueabihf@1.0.0-rc.15", "", { "os": "linux", "cpu": "arm" }, "sha512-cVwk0w8QbZJGTnP/AHQBs5yNwmpgGYStL88t4UIaqcvYJWBfS0s3oqVLZPwsPU6M0zlW4GqjP0Zq5MnAGwFeGA=="], - "@rolldown/binding-linux-arm64-gnu": ["@rolldown/binding-linux-arm64-gnu@1.0.0-rc.13", "", { "os": "linux", "cpu": "arm64" }, "sha512-ZfKWpXiUymDnavepCaM6KG/uGydJ4l2nBmMxg60Ci4CbeefpqjPWpfaZM7PThOhk2dssqBAcwLc6rAyr0uTdXg=="], + "@rolldown/binding-linux-arm64-gnu": ["@rolldown/binding-linux-arm64-gnu@1.0.0-rc.15", "", { "os": "linux", "cpu": "arm64" }, "sha512-eBZ/u8iAK9SoHGanqe/jrPnY0JvBN6iXbVOsbO38mbz+ZJsaobExAm1Iu+rxa4S1l2FjG0qEZn4Rc6X8n+9M+w=="], - "@rolldown/binding-linux-arm64-musl": ["@rolldown/binding-linux-arm64-musl@1.0.0-rc.13", "", { "os": "linux", "cpu": "arm64" }, "sha512-bmRg3O6Z0gq9yodKKWCIpnlH051sEfdVwt+6m5UDffAQMUUqU0xjnQqqAUm+Gu7ofAAly9DqiQDtKu2nPDEABA=="], + "@rolldown/binding-linux-arm64-musl": ["@rolldown/binding-linux-arm64-musl@1.0.0-rc.15", "", { "os": "linux", "cpu": "arm64" }, "sha512-ZvRYMGrAklV9PEkgt4LQM6MjQX2P58HPAuecwYObY2DhS2t35R0I810bKi0wmaYORt6m/2Sm+Z+nFgb0WhXNcQ=="], - "@rolldown/binding-linux-ppc64-gnu": ["@rolldown/binding-linux-ppc64-gnu@1.0.0-rc.13", "", { "os": "linux", "cpu": "ppc64" }, "sha512-8Wtnbw4k7pMYN9B/mOEAsQ8HOiq7AZ31Ig4M9BKn2So4xRaFEhtCSa4ZJaOutOWq50zpgR4N5+L/opnlaCx8wQ=="], + "@rolldown/binding-linux-ppc64-gnu": ["@rolldown/binding-linux-ppc64-gnu@1.0.0-rc.15", "", { "os": "linux", "cpu": "ppc64" }, "sha512-VDpgGBzgfg5hLg+uBpCLoFG5kVvEyafmfxGUV0UHLcL5irxAK7PKNeC2MwClgk6ZAiNhmo9FLhRYgvMmedLtnQ=="], - "@rolldown/binding-linux-s390x-gnu": ["@rolldown/binding-linux-s390x-gnu@1.0.0-rc.13", "", { "os": "linux", "cpu": "s390x" }, "sha512-D/0Nlo8mQuxSMohNJUF2lDXWRsFDsHldfRRgD9bRgktj+EndGPj4DOV37LqDKPYS+osdyhZEH7fTakTAEcW7qg=="], + "@rolldown/binding-linux-s390x-gnu": ["@rolldown/binding-linux-s390x-gnu@1.0.0-rc.15", "", { "os": "linux", "cpu": "s390x" }, "sha512-y1uXY3qQWCzcPgRJATPSOUP4tCemh4uBdY7e3EZbVwCJTY3gLJWnQABgeUetvED+bt1FQ01OeZwvhLS2bpNrAQ=="], - "@rolldown/binding-linux-x64-gnu": ["@rolldown/binding-linux-x64-gnu@1.0.0-rc.13", "", { "os": "linux", "cpu": "x64" }, "sha512-eRrPvat2YaVQcwwKi/JzOP6MKf1WRnOCr+VaI3cTWz3ZoLcP/654z90lVCJ4dAuMEpPdke0n+qyAqXDZdIC4rA=="], + "@rolldown/binding-linux-x64-gnu": ["@rolldown/binding-linux-x64-gnu@1.0.0-rc.15", "", { "os": "linux", "cpu": "x64" }, "sha512-023bTPBod7J3Y/4fzAN6QtpkSABR0rigtrwaP+qSEabUh5zf6ELr9Nc7GujaROuPY3uwdSIXWrvhn1KxOvurWA=="], - "@rolldown/binding-linux-x64-musl": ["@rolldown/binding-linux-x64-musl@1.0.0-rc.13", "", { "os": "linux", "cpu": "x64" }, "sha512-PsdONiFRp8hR8KgVjTWjZ9s7uA3uueWL0t74/cKHfM4dR5zXYv4AjB8BvA+QDToqxAFg4ZkcVEqeu5F7inoz5w=="], + "@rolldown/binding-linux-x64-musl": ["@rolldown/binding-linux-x64-musl@1.0.0-rc.15", "", { "os": "linux", "cpu": "x64" }, "sha512-witB2O0/hU4CgfOOKUoeFgQ4GktPi1eEbAhaLAIpgD6+ZnhcPkUtPsoKKHRzmOoWPZue46IThdSgdo4XneOLYw=="], - "@rolldown/binding-openharmony-arm64": ["@rolldown/binding-openharmony-arm64@1.0.0-rc.13", "", { "os": "none", "cpu": "arm64" }, "sha512-hCNXgC5dI3TVOLrPT++PKFNZ+1EtS0mLQwfXXXSUD/+rGlB65gZDwN/IDuxLpQP4x8RYYHqGomlUXzpO8aVI2w=="], + "@rolldown/binding-openharmony-arm64": ["@rolldown/binding-openharmony-arm64@1.0.0-rc.15", "", { "os": "none", "cpu": "arm64" }, "sha512-UCL68NJ0Ud5zRipXZE9dF5PmirzJE4E4BCIOOssEnM7wLDsxjc6Qb0sGDxTNRTP53I6MZpygyCpY8Aa8sPfKPg=="], - "@rolldown/binding-wasm32-wasi": ["@rolldown/binding-wasm32-wasi@1.0.0-rc.13", "", { "dependencies": { "@emnapi/core": "1.9.1", "@emnapi/runtime": "1.9.1", "@napi-rs/wasm-runtime": "^1.1.2" }, "cpu": "none" }, "sha512-viLS5C5et8NFtLWw9Sw3M/w4vvnVkbWkO7wSNh3C+7G1+uCkGpr6PcjNDSFcNtmXY/4trjPBqUfcOL+P3sWy/g=="], + "@rolldown/binding-wasm32-wasi": ["@rolldown/binding-wasm32-wasi@1.0.0-rc.15", "", { "dependencies": { "@emnapi/core": "1.9.2", "@emnapi/runtime": "1.9.2", "@napi-rs/wasm-runtime": "^1.1.3" }, "cpu": "none" }, "sha512-ApLruZq/ig+nhaE7OJm4lDjayUnOHVUa77zGeqnqZ9pn0ovdVbbNPerVibLXDmWeUZXjIYIT8V3xkT58Rm9u5Q=="], - "@rolldown/binding-win32-arm64-msvc": ["@rolldown/binding-win32-arm64-msvc@1.0.0-rc.13", "", { "os": "win32", "cpu": "arm64" }, "sha512-Fqa3Tlt1xL4wzmAYxGNFV36Hb+VfPc9PYU+E25DAnswXv3ODDu/yyWjQDbXMo5AGWkQVjLgQExuVu8I/UaZhPQ=="], + "@rolldown/binding-win32-arm64-msvc": ["@rolldown/binding-win32-arm64-msvc@1.0.0-rc.15", "", { "os": "win32", "cpu": "arm64" }, "sha512-KmoUoU7HnN+Si5YWJigfTws1jz1bKBYDQKdbLspz0UaqjjFkddHsqorgiW1mxcAj88lYUE6NC/zJNwT+SloqtA=="], - "@rolldown/binding-win32-x64-msvc": ["@rolldown/binding-win32-x64-msvc@1.0.0-rc.13", "", { "os": "win32", "cpu": "x64" }, "sha512-/pLI5kPkGEi44TDlnbio3St/5gUFeN51YWNAk/Gnv6mEQBOahRBh52qVFVBpmrnU01n2yysvBML9Ynu7K4kGAQ=="], + "@rolldown/binding-win32-x64-msvc": ["@rolldown/binding-win32-x64-msvc@1.0.0-rc.15", "", { "os": "win32", "cpu": "x64" }, "sha512-3P2A8L+x75qavWLe/Dll3EYBJLQmtkJN8rfh+U/eR3MqMgL/h98PhYI+JFfXuDPgPeCB7iZAKiqii5vqOvnA0g=="], - "@rolldown/pluginutils": ["@rolldown/pluginutils@1.0.0-rc.13", "", {}, "sha512-3ngTAv6F/Py35BsYbeeLeecvhMKdsKm4AoOETVhAA+Qc8nrA2I0kF7oa93mE9qnIurngOSpMnQ0x2nQY2FPviA=="], + "@rolldown/pluginutils": ["@rolldown/pluginutils@1.0.0-rc.15", "", {}, "sha512-UromN0peaE53IaBRe9W7CjrZgXl90fqGpK+mIZbA3qSTeYqg3pqpROBdIPvOG3F5ereDHNwoHBI2e50n1BDr1g=="], - "@sentry-internal/browser-utils": ["@sentry-internal/browser-utils@10.47.0", "", { "dependencies": { "@sentry/core": "10.47.0" } }, "sha512-bVFRAeJWMBcBCvJKIFCMJ1/yQToL4vPGqfmlnDZeypcxkqUDKQ/Y3ziLHXoDL2sx0lagcgU2vH1QhCQ67Aujjw=="], + "@sentry-internal/browser-utils": ["@sentry-internal/browser-utils@10.48.0", "", { "dependencies": { "@sentry/core": "10.48.0" } }, "sha512-SCiTLBXzugFKxev6NoKYBIhQoDk0gUh0AVVVepCBqfCJiWBG01Zvv0R5tCVohr4cWRllkQ8mlBdNQd/I7s9tdA=="], - "@sentry-internal/feedback": ["@sentry-internal/feedback@10.47.0", "", { "dependencies": { "@sentry/core": "10.47.0" } }, "sha512-pdvMmi4dQpX5S/vAAzrhHPIw3T3HjUgDNgUiCBrlp7N9/6zGO2gNPhUnNekP+CjgI/z0rvf49RLqlDenpNrMOg=="], + "@sentry-internal/feedback": ["@sentry-internal/feedback@10.48.0", "", { "dependencies": { "@sentry/core": "10.48.0" } }, "sha512-tGkEyOM1HDS9qebDphUMEnyk3qq/50AnuTBiFmMJyjNzowylVGmRRk0sr3xkmbVHCDXQCiYnDmSVlJ2x4SDMrQ=="], - "@sentry-internal/replay": ["@sentry-internal/replay@10.47.0", "", { "dependencies": { "@sentry-internal/browser-utils": "10.47.0", "@sentry/core": "10.47.0" } }, "sha512-ScdovxP7hJxgMt70+7hFvwT02GIaIUAxdEM/YPsayZBeCoAukPW8WiwztJfoKtsfPyKJ5A6f0H3PIxTPcA9Row=="], + "@sentry-internal/replay": ["@sentry-internal/replay@10.48.0", "", { "dependencies": { "@sentry-internal/browser-utils": "10.48.0", "@sentry/core": "10.48.0" } }, "sha512-sevRTePfuk4PNuz9KAKpmTZEomAU0aLXyIhOwA0OnUDdxPhkY8kq5lwDbuxTHv6DQUjUX3YgFbY45VH1JEqHKA=="], - "@sentry-internal/replay-canvas": ["@sentry-internal/replay-canvas@10.47.0", "", { "dependencies": { "@sentry-internal/replay": "10.47.0", "@sentry/core": "10.47.0" } }, "sha512-A5OY8friSe6g8WAK4L8IeOPiEd9D3Ps40DzRH5j2f6SUja0t90mKMvHRcRf8zq0d4BkdB+JM7tjOkwxpuv8heA=="], + "@sentry-internal/replay-canvas": ["@sentry-internal/replay-canvas@10.48.0", "", { "dependencies": { "@sentry-internal/replay": "10.48.0", "@sentry/core": "10.48.0" } }, "sha512-9nWuN2z4O+iwbTfuYV5ZmngBgJU/ZxfOo47A5RJP3Nu/kl59aJ1lUhILYOKyeNOIC/JyeERmpIcTxnlPXQzZ3Q=="], - "@sentry/browser": ["@sentry/browser@10.47.0", "", { "dependencies": { "@sentry-internal/browser-utils": "10.47.0", "@sentry-internal/feedback": "10.47.0", "@sentry-internal/replay": "10.47.0", "@sentry-internal/replay-canvas": "10.47.0", "@sentry/core": "10.47.0" } }, "sha512-rC0agZdxKA5XWfL4VwPOr/rJMogXDqZgnVzr93YWpFn9DMZT/7LzxSJVPIJwRUjx3bFEby3PcTa3YaX7pxm1AA=="], + "@sentry/browser": ["@sentry/browser@10.48.0", "", { "dependencies": { "@sentry-internal/browser-utils": "10.48.0", "@sentry-internal/feedback": "10.48.0", "@sentry-internal/replay": "10.48.0", "@sentry-internal/replay-canvas": "10.48.0", "@sentry/core": "10.48.0" } }, "sha512-4jt2zX2ExgFcNe2x+W+/k81fmDUsOrquGtt028CiGuDuma6kEsWBI4JbooT1jhj2T+eeUxe3YGbM23Zhh7Ghhw=="], - "@sentry/core": ["@sentry/core@10.47.0", "", {}, "sha512-nsYRAx3EWezDut+Zl+UwwP07thh9uY7CfSAi2whTdcJl5hu1nSp2z8bba7Vq/MGbNLnazkd3A+GITBEML924JA=="], + "@sentry/core": ["@sentry/core@10.48.0", "", {}, "sha512-h8F+fXVwYC9ro5ZaO8V+v3vqc0awlXHGblEAuVxSGgh4IV/oFX+QVzXeDTTrFOFS6v/Vn5vAyu240eJrJAS6/g=="], "@sindresorhus/base62": ["@sindresorhus/base62@1.0.0", "", {}, "sha512-TeheYy0ILzBEI/CO55CP6zJCSdSWeRtGnHy8U8dWSUH4I68iqTsy7HkMktR4xakThc9jotkPQUXT4ITdbV7cHA=="], @@ -566,7 +566,7 @@ "@tybys/wasm-util": ["@tybys/wasm-util@0.10.1", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-9tTaPJLSiejZKx+Bmog4uSubteqTvFrVrURwkmHixBo0G4seD0zUxp98E1DzUBJxLQ3NPwXrGKDiVjwx/DpPsg=="], - "@types/bun": ["@types/bun@1.3.11", "", { "dependencies": { "bun-types": "1.3.11" } }, "sha512-5vPne5QvtpjGpsGYXiFyycfpDF2ECyPcTSsFBMa0fraoxiQyMJ3SmuQIGhzPg2WJuWxVBoxWJ2kClYTcw/4fAg=="], + "@types/bun": ["@types/bun@1.3.12", "", { "dependencies": { "bun-types": "1.3.12" } }, "sha512-DBv81elK+/VSwXHDlnH3Qduw+KxkTIWi7TXkAeh24zpi5l0B2kUg9Ga3tb4nJaPcOFswflgi/yAvMVBPrxMB+A=="], "@types/debug": ["@types/debug@4.1.13", "", { "dependencies": { "@types/ms": "*" } }, "sha512-KSVgmQmzMwPlmtljOomayoR89W4FynCAi3E8PPs7vmDVPe84hT+vGPKkJfThkmXs0x0jAaa9U8uW8bbfyS2fWw=="], @@ -580,7 +580,7 @@ "@types/ms": ["@types/ms@2.1.0", "", {}, "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA=="], - "@types/node": ["@types/node@25.5.2", "", { "dependencies": { "undici-types": "~7.18.0" } }, "sha512-tO4ZIRKNC+MDWV4qKVZe3Ql/woTnmHDr5JD8UI5hn2pwBrHEwOEMZK7WlNb5RKB6EoJ02gwmQS9OrjuFnZYdpg=="], + "@types/node": ["@types/node@25.6.0", "", { "dependencies": { "undici-types": "~7.19.0" } }, "sha512-+qIYRKdNYJwY3vRCZMdJbPLJAtGjQBudzZzdzwQYkEPQd+PJGixUL5QfvCLDaULoLv+RhT3LDkwEfKaAkgSmNQ=="], "@types/trusted-types": ["@types/trusted-types@2.0.7", "", {}, "sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw=="], @@ -592,17 +592,17 @@ "@typescript-eslint/project-service": ["@typescript-eslint/project-service@8.58.1", "", { "dependencies": { "@typescript-eslint/tsconfig-utils": "^8.58.1", "@typescript-eslint/types": "^8.58.1", "debug": "^4.4.3" }, "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-gfQ8fk6cxhtptek+/8ZIqw8YrRW5048Gug8Ts5IYcMLCw18iUgrZAEY/D7s4hkI0FxEfGakKuPK/XUMPzPxi5g=="], - "@typescript-eslint/scope-manager": ["@typescript-eslint/scope-manager@8.58.0", "", { "dependencies": { "@typescript-eslint/types": "8.58.0", "@typescript-eslint/visitor-keys": "8.58.0" } }, "sha512-W1Lur1oF50FxSnNdGp3Vs6P+yBRSmZiw4IIjEeYxd8UQJwhUF0gDgDD/W/Tgmh73mxgEU3qX0Bzdl/NGuSPEpQ=="], + "@typescript-eslint/scope-manager": ["@typescript-eslint/scope-manager@8.58.1", "", { "dependencies": { "@typescript-eslint/types": "8.58.1", "@typescript-eslint/visitor-keys": "8.58.1" } }, "sha512-TPYUEqJK6avLcEjumWsIuTpuYODTTDAtoMdt8ZZa93uWMTX13Nb8L5leSje1NluammvU+oI3QRr5lLXPgihX3w=="], "@typescript-eslint/tsconfig-utils": ["@typescript-eslint/tsconfig-utils@8.58.1", "", { "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-JAr2hOIct2Q+qk3G+8YFfqkqi7sC86uNryT+2i5HzMa2MPjw4qNFvtjnw1IiA1rP7QhNKVe21mSSLaSjwA1Olw=="], - "@typescript-eslint/type-utils": ["@typescript-eslint/type-utils@8.58.0", "", { "dependencies": { "@typescript-eslint/types": "8.58.0", "@typescript-eslint/typescript-estree": "8.58.0", "@typescript-eslint/utils": "8.58.0", "debug": "^4.4.3", "ts-api-utils": "^2.5.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-aGsCQImkDIqMyx1u4PrVlbi/krmDsQUs4zAcCV6M7yPcPev+RqVlndsJy9kJ8TLihW9TZ0kbDAzctpLn5o+lOg=="], + "@typescript-eslint/type-utils": ["@typescript-eslint/type-utils@8.58.1", "", { "dependencies": { "@typescript-eslint/types": "8.58.1", "@typescript-eslint/typescript-estree": "8.58.1", "@typescript-eslint/utils": "8.58.1", "debug": "^4.4.3", "ts-api-utils": "^2.5.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-HUFxvTJVroT+0rXVJC7eD5zol6ID+Sn5npVPWoFuHGg9Ncq5Q4EYstqR+UOqaNRFXi5TYkpXXkLhoCHe3G0+7w=="], - "@typescript-eslint/types": ["@typescript-eslint/types@8.58.0", "", {}, "sha512-O9CjxypDT89fbHxRfETNoAnHj/i6IpRK0CvbVN3qibxlLdo5p5hcLmUuCCrHMpxiWSwKyI8mCP7qRNYuOJ0Uww=="], + "@typescript-eslint/types": ["@typescript-eslint/types@8.58.1", "", {}, "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw=="], "@typescript-eslint/typescript-estree": ["@typescript-eslint/typescript-estree@8.58.1", "", { "dependencies": { "@typescript-eslint/project-service": "8.58.1", "@typescript-eslint/tsconfig-utils": "8.58.1", "@typescript-eslint/types": "8.58.1", "@typescript-eslint/visitor-keys": "8.58.1", "debug": "^4.4.3", "minimatch": "^10.2.2", "semver": "^7.7.3", "tinyglobby": "^0.2.15", "ts-api-utils": "^2.5.0" }, "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-w4w7WR7GHOjqqPnvAYbazq+Y5oS68b9CzasGtnd6jIeOIeKUzYzupGTB2T4LTPSv4d+WPeccbxuneTFHYgAAWg=="], - "@typescript-eslint/utils": ["@typescript-eslint/utils@8.58.0", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.9.1", "@typescript-eslint/scope-manager": "8.58.0", "@typescript-eslint/types": "8.58.0", "@typescript-eslint/typescript-estree": "8.58.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-RfeSqcFeHMHlAWzt4TBjWOAtoW9lnsAGiP3GbaX9uVgTYYrMbVnGONEfUCiSss+xMHFl+eHZiipmA8WkQ7FuNA=="], + "@typescript-eslint/utils": ["@typescript-eslint/utils@8.58.1", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.9.1", "@typescript-eslint/scope-manager": "8.58.1", "@typescript-eslint/types": "8.58.1", "@typescript-eslint/typescript-estree": "8.58.1" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-Ln8R0tmWC7pTtLOzgJzYTXSCjJ9rDNHAqTaVONF4FEi2qwce8mD9iSOxOpLFFvWp/wBFlew0mjM1L1ihYWfBdQ=="], "@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.58.1", "", { "dependencies": { "@typescript-eslint/types": "8.58.1", "eslint-visitor-keys": "^5.0.0" } }, "sha512-y+vH7QE8ycjoa0bWciFg7OpFcipUuem1ujhrdLtq1gByKwfbC7bPeKsiny9e0urg93DqwGcHey+bGRKCnF1nZQ=="], @@ -694,7 +694,7 @@ "balanced-match": ["balanced-match@4.0.4", "", {}, "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA=="], - "baseline-browser-mapping": ["baseline-browser-mapping@2.10.13", "", { "bin": { "baseline-browser-mapping": "dist/cli.cjs" } }, "sha512-BL2sTuHOdy0YT1lYieUxTw/QMtPBC3pmlJC6xk8BBYVv6vcw3SGdKemQ+Xsx9ik2F/lYDO9tqsFQH1r9PFuHKw=="], + "baseline-browser-mapping": ["baseline-browser-mapping@2.10.17", "", { "bin": { "baseline-browser-mapping": "dist/cli.cjs" } }, "sha512-HdrkN8eVG2CXxeifv/VdJ4A4RSra1DTW8dc/hdxzhGHN8QePs6gKaWM9pHPcpCoxYZJuOZ8drHmbdpLHjCYjLA=="], "better-typescript-lib": ["better-typescript-lib@2.12.0", "", { "dependencies": { "@typescript/lib-decorators": "npm:@better-typescript-lib/decorators@2.12.0", "@typescript/lib-dom": "npm:@better-typescript-lib/dom@2.12.0", "@typescript/lib-es2015": "npm:@better-typescript-lib/es2015@2.12.0", "@typescript/lib-es2016": "npm:@better-typescript-lib/es2016@2.12.0", "@typescript/lib-es2017": "npm:@better-typescript-lib/es2017@2.12.0", "@typescript/lib-es2018": "npm:@better-typescript-lib/es2018@2.12.0", "@typescript/lib-es2019": "npm:@better-typescript-lib/es2019@2.12.0", "@typescript/lib-es2020": "npm:@better-typescript-lib/es2020@2.12.0", "@typescript/lib-es2021": "npm:@better-typescript-lib/es2021@2.12.0", "@typescript/lib-es2022": "npm:@better-typescript-lib/es2022@2.12.0", "@typescript/lib-es2023": "npm:@better-typescript-lib/es2023@2.12.0", "@typescript/lib-es2024": "npm:@better-typescript-lib/es2024@2.12.0", "@typescript/lib-es5": "npm:@better-typescript-lib/es5@2.12.0", "@typescript/lib-es6": "npm:@better-typescript-lib/es6@2.12.0", "@typescript/lib-esnext": "npm:@better-typescript-lib/esnext@2.12.0", "@typescript/lib-scripthost": "npm:@better-typescript-lib/scripthost@2.12.0", "@typescript/lib-webworker": "npm:@better-typescript-lib/webworker@2.12.0" }, "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-f7eO5Xs6Cczfx5eDRuDw/JYCrsdiC6gXdleB2KFZ5ZYgU/RRoev9swjt/eD0xo9PRDqNDwyjKx0n27CDHRZwvQ=="], @@ -712,13 +712,13 @@ "builtin-modules": ["builtin-modules@3.3.0", "", {}, "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw=="], - "bun-types": ["bun-types@1.3.11", "", { "dependencies": { "@types/node": "*" } }, "sha512-1KGPpoxQWl9f6wcZh57LvrPIInQMn2TQ7jsgxqpRzg+l0QPOFvJVH7HmvHo/AiPgwXy+/Thf6Ov3EdVn1vOabg=="], + "bun-types": ["bun-types@1.3.12", "", { "dependencies": { "@types/node": "*" } }, "sha512-HqOLj5PoFajAQciOMRiIZGNoKxDJSr6qigAttOX40vJuSp6DN/CxWp9s3C1Xwm4oH7ybueITwiaOcWXoYVoRkA=="], "bytes": ["bytes@3.1.2", "", {}, "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg=="], "cacheable": ["cacheable@2.3.4", "", { "dependencies": { "@cacheable/memory": "^2.0.8", "@cacheable/utils": "^2.4.0", "hookified": "^1.15.0", "keyv": "^5.6.0", "qified": "^0.9.0" } }, "sha512-djgxybDbw9fL/ZWMI3+CE8ZilNxcwFkVtDc1gJ+IlOSSWkSMPQabhV/XCHTQ6pwwN6aivXPZ43omTooZiX06Ew=="], - "call-bind": ["call-bind@1.0.8", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.0", "es-define-property": "^1.0.0", "get-intrinsic": "^1.2.4", "set-function-length": "^1.2.2" } }, "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww=="], + "call-bind": ["call-bind@1.0.9", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.2", "es-define-property": "^1.0.1", "get-intrinsic": "^1.3.0", "set-function-length": "^1.2.2" } }, "sha512-a/hy+pNsFUTR+Iz8TCJvXudKVLAnz/DyeSUo10I5yvFDQJBFU2s9uqQpoSrJlroHUKoKqzg+epxyP9lqFdzfBQ=="], "call-bind-apply-helpers": ["call-bind-apply-helpers@1.0.2", "", { "dependencies": { "es-errors": "^1.3.0", "function-bind": "^1.1.2" } }, "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ=="], @@ -796,9 +796,9 @@ "dunder-proto": ["dunder-proto@1.0.1", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.1", "es-errors": "^1.3.0", "gopd": "^1.2.0" } }, "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A=="], - "effect": ["effect@4.0.0-beta.43", "", { "dependencies": { "@standard-schema/spec": "^1.1.0", "fast-check": "^4.5.3", "find-my-way-ts": "^0.1.6", "ini": "^6.0.0", "kubernetes-types": "^1.30.0", "msgpackr": "^1.11.8", "multipasta": "^0.2.7", "toml": "^3.0.0", "uuid": "^13.0.0", "yaml": "^2.8.2" } }, "sha512-AJYyDimIwJOn87uUz/JzmgDc5GfjxJbXvEbTvNzMa+M3Uer344bLo/O5mMRkqc1vBleA+Ygs4+dbE3QsqOkKTQ=="], + "effect": ["effect@4.0.0-beta.46", "", { "dependencies": { "@standard-schema/spec": "^1.1.0", "fast-check": "^4.5.3", "find-my-way-ts": "^0.1.6", "ini": "^6.0.0", "kubernetes-types": "^1.30.0", "msgpackr": "^1.11.8", "multipasta": "^0.2.7", "toml": "^3.0.0", "uuid": "^13.0.0", "yaml": "^2.8.2" } }, "sha512-3f6gXvvUMtEueCRY0tU76Vq2Pej1SAwwE+s0Owd5nD53yS5n4RZhUA1rlCGFuSbQFA225pGy8vO72+lpvu7u5A=="], - "electron-to-chromium": ["electron-to-chromium@1.5.331", "", {}, "sha512-IbxXrsTlD3hRodkLnbxAPP4OuJYdWCeM3IOdT+CpcMoIwIoDfCmRpEtSPfwBXxVkg9xmBeY7Lz2Eo2TDn/HC3Q=="], + "electron-to-chromium": ["electron-to-chromium@1.5.334", "", {}, "sha512-mgjZAz7Jyx1SRCwEpy9wefDS7GvNPazLthHg8eQMJ76wBdGQQDW33TCrUTvQ4wzpmOrv2zrFoD3oNufMdyMpog=="], "emoji-regex": ["emoji-regex@9.2.2", "", {}, "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg=="], @@ -808,7 +808,7 @@ "error-ex": ["error-ex@1.3.4", "", { "dependencies": { "is-arrayish": "^0.2.1" } }, "sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ=="], - "es-abstract": ["es-abstract@1.24.1", "", { "dependencies": { "array-buffer-byte-length": "^1.0.2", "arraybuffer.prototype.slice": "^1.0.4", "available-typed-arrays": "^1.0.7", "call-bind": "^1.0.8", "call-bound": "^1.0.4", "data-view-buffer": "^1.0.2", "data-view-byte-length": "^1.0.2", "data-view-byte-offset": "^1.0.1", "es-define-property": "^1.0.1", "es-errors": "^1.3.0", "es-object-atoms": "^1.1.1", "es-set-tostringtag": "^2.1.0", "es-to-primitive": "^1.3.0", "function.prototype.name": "^1.1.8", "get-intrinsic": "^1.3.0", "get-proto": "^1.0.1", "get-symbol-description": "^1.1.0", "globalthis": "^1.0.4", "gopd": "^1.2.0", "has-property-descriptors": "^1.0.2", "has-proto": "^1.2.0", "has-symbols": "^1.1.0", "hasown": "^2.0.2", "internal-slot": "^1.1.0", "is-array-buffer": "^3.0.5", "is-callable": "^1.2.7", "is-data-view": "^1.0.2", "is-negative-zero": "^2.0.3", "is-regex": "^1.2.1", "is-set": "^2.0.3", "is-shared-array-buffer": "^1.0.4", "is-string": "^1.1.1", "is-typed-array": "^1.1.15", "is-weakref": "^1.1.1", "math-intrinsics": "^1.1.0", "object-inspect": "^1.13.4", "object-keys": "^1.1.1", "object.assign": "^4.1.7", "own-keys": "^1.0.1", "regexp.prototype.flags": "^1.5.4", "safe-array-concat": "^1.1.3", "safe-push-apply": "^1.0.0", "safe-regex-test": "^1.1.0", "set-proto": "^1.0.0", "stop-iteration-iterator": "^1.1.0", "string.prototype.trim": "^1.2.10", "string.prototype.trimend": "^1.0.9", "string.prototype.trimstart": "^1.0.8", "typed-array-buffer": "^1.0.3", "typed-array-byte-length": "^1.0.3", "typed-array-byte-offset": "^1.0.4", "typed-array-length": "^1.0.7", "unbox-primitive": "^1.1.0", "which-typed-array": "^1.1.19" } }, "sha512-zHXBLhP+QehSSbsS9Pt23Gg964240DPd6QCf8WpkqEXxQ7fhdZzYsocOr5u7apWonsS5EjZDmTF+/slGMyasvw=="], + "es-abstract": ["es-abstract@1.24.2", "", { "dependencies": { "array-buffer-byte-length": "^1.0.2", "arraybuffer.prototype.slice": "^1.0.4", "available-typed-arrays": "^1.0.7", "call-bind": "^1.0.8", "call-bound": "^1.0.4", "data-view-buffer": "^1.0.2", "data-view-byte-length": "^1.0.2", "data-view-byte-offset": "^1.0.1", "es-define-property": "^1.0.1", "es-errors": "^1.3.0", "es-object-atoms": "^1.1.1", "es-set-tostringtag": "^2.1.0", "es-to-primitive": "^1.3.0", "function.prototype.name": "^1.1.8", "get-intrinsic": "^1.3.0", "get-proto": "^1.0.1", "get-symbol-description": "^1.1.0", "globalthis": "^1.0.4", "gopd": "^1.2.0", "has-property-descriptors": "^1.0.2", "has-proto": "^1.2.0", "has-symbols": "^1.1.0", "hasown": "^2.0.2", "internal-slot": "^1.1.0", "is-array-buffer": "^3.0.5", "is-callable": "^1.2.7", "is-data-view": "^1.0.2", "is-negative-zero": "^2.0.3", "is-regex": "^1.2.1", "is-set": "^2.0.3", "is-shared-array-buffer": "^1.0.4", "is-string": "^1.1.1", "is-typed-array": "^1.1.15", "is-weakref": "^1.1.1", "math-intrinsics": "^1.1.0", "object-inspect": "^1.13.4", "object-keys": "^1.1.1", "object.assign": "^4.1.7", "own-keys": "^1.0.1", "regexp.prototype.flags": "^1.5.4", "safe-array-concat": "^1.1.3", "safe-push-apply": "^1.0.0", "safe-regex-test": "^1.1.0", "set-proto": "^1.0.0", "stop-iteration-iterator": "^1.1.0", "string.prototype.trim": "^1.2.10", "string.prototype.trimend": "^1.0.9", "string.prototype.trimstart": "^1.0.8", "typed-array-buffer": "^1.0.3", "typed-array-byte-length": "^1.0.3", "typed-array-byte-offset": "^1.0.4", "typed-array-length": "^1.0.7", "unbox-primitive": "^1.1.0", "which-typed-array": "^1.1.19" } }, "sha512-2FpH9Q5i2RRwyEP1AylXe6nYLR5OhaJTZwmlcP0dL/+JCbgg7yyEo/sEK6HeGZRf3dFpWwThaRHVApXSkW3xeg=="], "es-define-property": ["es-define-property@1.0.1", "", {}, "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g=="], @@ -830,7 +830,7 @@ "eslint-compat-utils": ["eslint-compat-utils@0.6.5", "", { "dependencies": { "semver": "^7.5.4" }, "peerDependencies": { "eslint": ">=6.0.0" } }, "sha512-vAUHYzue4YAa2hNACjB8HvUQj5yehAZgiClyFVVom9cP8z5NSFq3PwB/TtJslN2zAMgRX6FCFCjYBbQh71g5RQ=="], - "eslint-plugin-astro": ["eslint-plugin-astro@1.6.0", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@jridgewell/sourcemap-codec": "^1.4.14", "@typescript-eslint/types": "^7.7.1 || ^8", "astro-eslint-parser": "^1.3.0", "eslint-compat-utils": "^0.6.0", "globals": "^16.0.0", "postcss": "^8.4.14", "postcss-selector-parser": "^7.0.0" }, "peerDependencies": { "eslint": ">=8.57.0" } }, "sha512-yGIbLHuj5MOUXa0s4sZ6cVhv6ehb+WLF80tsrGaxMk6VTUExruMzubQDzhOYt8fbR1c9vILCCRSCsKI7M1whig=="], + "eslint-plugin-astro": ["eslint-plugin-astro@1.7.0", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@jridgewell/sourcemap-codec": "^1.4.14", "@typescript-eslint/types": "^7.7.1 || ^8", "astro-eslint-parser": "^1.3.0", "eslint-compat-utils": "^0.6.0", "globals": "^16.0.0", "postcss": "^8.4.14", "postcss-selector-parser": "^7.0.0" }, "peerDependencies": { "eslint": ">=8.57.0" } }, "sha512-89xpAn528UKCdmyysbg0AHHqi6sqcK89wXnJIpu4F0mFBN03zATEBNK7pRtMfl6gwtMOm5ECXs+Wz5qDHhwTFw=="], "eslint-plugin-functional": ["eslint-plugin-functional@9.0.4", "", { "dependencies": { "@typescript-eslint/utils": "^8.26.0", "deepmerge-ts": "^7.1.5", "escape-string-regexp": "^5.0.0", "is-immutable-type": "^5.0.1", "ts-api-utils": "^2.0.1", "ts-declaration-location": "^1.0.6" }, "peerDependencies": { "eslint": "^9.0.0 || ^10.0.0", "typescript": ">=4.7.4" }, "optionalPeers": ["typescript"] }, "sha512-zm4qaoqb2r50V4WXxt0Mj92buXGMECYvMxGQ6sSb+XeJ+Eec6zCHuMY2+AWK1mqiApvUz2tCtp1P3zcEPU0huw=="], @@ -1290,7 +1290,7 @@ "possible-typed-array-names": ["possible-typed-array-names@1.1.0", "", {}, "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg=="], - "postcss": ["postcss@8.5.8", "", { "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" } }, "sha512-OW/rX8O/jXnm82Ey1k44pObPtdblfiuWnrd8X7GJ7emImCOstunGbXUpp7HdBrFQX6rJzn3sPT397Wp5aCwCHg=="], + "postcss": ["postcss@8.5.9", "", { "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" } }, "sha512-7a70Nsot+EMX9fFU3064K/kdHWZqGVY+BADLyXc8Dfv+mTLLVl6JzJpPaCZ2kQL9gIJvKXSLMHhqdRRjwQeFtw=="], "postcss-media-query-parser": ["postcss-media-query-parser@0.2.3", "", {}, "sha512-3sOlxmbKcSHMjlUXQZKQ06jOswE7oVkXPxmZdoB1r5l0q6gTFTQSHxNxOrCccElbW7dxNytifNEo8qidX2Vsig=="], @@ -1308,7 +1308,7 @@ "prelude-ls": ["prelude-ls@1.2.1", "", {}, "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g=="], - "prettier": ["prettier@3.8.1", "", { "bin": { "prettier": "bin/prettier.cjs" } }, "sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg=="], + "prettier": ["prettier@3.8.2", "", { "bin": { "prettier": "bin/prettier.cjs" } }, "sha512-8c3mgTe0ASwWAJK+78dpviD+A8EqhndQPUBpNUIPt6+xWlIigCwfN01lWr9MAede4uqXGTEKeQWTvzb3vjia0Q=="], "prettier-plugin-curly": ["prettier-plugin-curly@0.4.1", "", { "peerDependencies": { "prettier": "^3" } }, "sha512-Xc7zatoD0/08zYFv+hwnlqT5ekM81DCbBr73CWAsr1Fmx7qLQT/M0wfPx6w/+zfnmXH009xYvjzLUPcwzq7Fbw=="], @@ -1354,7 +1354,7 @@ "regjsgen": ["regjsgen@0.8.0", "", {}, "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q=="], - "regjsparser": ["regjsparser@0.13.0", "", { "dependencies": { "jsesc": "~3.1.0" }, "bin": { "regjsparser": "bin/parser" } }, "sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q=="], + "regjsparser": ["regjsparser@0.13.1", "", { "dependencies": { "jsesc": "~3.1.0" }, "bin": { "regjsparser": "bin/parser" } }, "sha512-dLsljMd9sqwRkby8zhO1gSg3PnJIBFid8f4CQj/sXx+7cKx+E7u0PKhZ+U4wmhx7EfmtvnA318oVaIkAB1lRJw=="], "require-from-string": ["require-from-string@2.0.2", "", {}, "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw=="], @@ -1368,7 +1368,7 @@ "reusify": ["reusify@1.1.0", "", {}, "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw=="], - "rolldown": ["rolldown@1.0.0-rc.13", "", { "dependencies": { "@oxc-project/types": "=0.123.0", "@rolldown/pluginutils": "1.0.0-rc.13" }, "optionalDependencies": { "@rolldown/binding-android-arm64": "1.0.0-rc.13", "@rolldown/binding-darwin-arm64": "1.0.0-rc.13", "@rolldown/binding-darwin-x64": "1.0.0-rc.13", "@rolldown/binding-freebsd-x64": "1.0.0-rc.13", "@rolldown/binding-linux-arm-gnueabihf": "1.0.0-rc.13", "@rolldown/binding-linux-arm64-gnu": "1.0.0-rc.13", "@rolldown/binding-linux-arm64-musl": "1.0.0-rc.13", "@rolldown/binding-linux-ppc64-gnu": "1.0.0-rc.13", "@rolldown/binding-linux-s390x-gnu": "1.0.0-rc.13", "@rolldown/binding-linux-x64-gnu": "1.0.0-rc.13", "@rolldown/binding-linux-x64-musl": "1.0.0-rc.13", "@rolldown/binding-openharmony-arm64": "1.0.0-rc.13", "@rolldown/binding-wasm32-wasi": "1.0.0-rc.13", "@rolldown/binding-win32-arm64-msvc": "1.0.0-rc.13", "@rolldown/binding-win32-x64-msvc": "1.0.0-rc.13" }, "bin": { "rolldown": "bin/cli.mjs" } }, "sha512-bvVj8YJmf0rq4pSFmH7laLa6pYrhghv3PRzrCdRAr23g66zOKVJ4wkvFtgohtPLWmthgg8/rkaqRHrpUEh0Zbw=="], + "rolldown": ["rolldown@1.0.0-rc.15", "", { "dependencies": { "@oxc-project/types": "=0.124.0", "@rolldown/pluginutils": "1.0.0-rc.15" }, "optionalDependencies": { "@rolldown/binding-android-arm64": "1.0.0-rc.15", "@rolldown/binding-darwin-arm64": "1.0.0-rc.15", "@rolldown/binding-darwin-x64": "1.0.0-rc.15", "@rolldown/binding-freebsd-x64": "1.0.0-rc.15", "@rolldown/binding-linux-arm-gnueabihf": "1.0.0-rc.15", "@rolldown/binding-linux-arm64-gnu": "1.0.0-rc.15", "@rolldown/binding-linux-arm64-musl": "1.0.0-rc.15", "@rolldown/binding-linux-ppc64-gnu": "1.0.0-rc.15", "@rolldown/binding-linux-s390x-gnu": "1.0.0-rc.15", "@rolldown/binding-linux-x64-gnu": "1.0.0-rc.15", "@rolldown/binding-linux-x64-musl": "1.0.0-rc.15", "@rolldown/binding-openharmony-arm64": "1.0.0-rc.15", "@rolldown/binding-wasm32-wasi": "1.0.0-rc.15", "@rolldown/binding-win32-arm64-msvc": "1.0.0-rc.15", "@rolldown/binding-win32-x64-msvc": "1.0.0-rc.15" }, "bin": { "rolldown": "bin/cli.mjs" } }, "sha512-Ff31guA5zT6WjnGp0SXw76X6hzGRk/OQq2hE+1lcDe+lJdHSgnSX6nK3erbONHyCbpSj9a9E+uX/OvytZoWp2g=="], "run-parallel": ["run-parallel@1.2.0", "", { "dependencies": { "queue-microtask": "^1.2.2" } }, "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA=="], @@ -1438,7 +1438,7 @@ "side-channel": ["side-channel@1.1.0", "", { "dependencies": { "es-errors": "^1.3.0", "object-inspect": "^1.13.3", "side-channel-list": "^1.0.0", "side-channel-map": "^1.0.1", "side-channel-weakmap": "^1.0.2" } }, "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw=="], - "side-channel-list": ["side-channel-list@1.0.0", "", { "dependencies": { "es-errors": "^1.3.0", "object-inspect": "^1.13.3" } }, "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA=="], + "side-channel-list": ["side-channel-list@1.0.1", "", { "dependencies": { "es-errors": "^1.3.0", "object-inspect": "^1.13.4" } }, "sha512-mjn/0bi/oUURjc5Xl7IaWi/OJJJumuoJFQJfDDyO46+hBWsfaVM65TBHq2eoZBhzl9EchxOijpkbRC8SVBQU0w=="], "side-channel-map": ["side-channel-map@1.0.1", "", { "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", "get-intrinsic": "^1.2.5", "object-inspect": "^1.13.3" } }, "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA=="], @@ -1490,7 +1490,7 @@ "stylelint-config-recommended": ["stylelint-config-recommended@18.0.0", "", { "peerDependencies": { "stylelint": "^17.0.0" } }, "sha512-mxgT2XY6YZ3HWWe3Di8umG6aBmWmHTblTgu/f10rqFXnyWxjKWwNdjSWkgkwCtxIKnqjSJzvFmPT5yabVIRxZg=="], - "stylelint-config-recommended-scss": ["stylelint-config-recommended-scss@17.0.0", "", { "dependencies": { "postcss-scss": "^4.0.9", "stylelint-config-recommended": "^18.0.0", "stylelint-scss": "^7.0.0" }, "peerDependencies": { "postcss": "^8.3.3", "stylelint": "^17.0.0" }, "optionalPeers": ["postcss"] }, "sha512-VkVD9r7jfUT/dq3mA3/I1WXXk2U71rO5wvU2yIil9PW5o1g3UM7Xc82vHmuVJHV7Y8ok5K137fmW5u3HbhtTOA=="], + "stylelint-config-recommended-scss": ["stylelint-config-recommended-scss@17.0.1", "", { "dependencies": { "postcss-scss": "^4.0.9", "stylelint-config-recommended": "^18.0.0", "stylelint-scss": "^7.0.0" }, "peerDependencies": { "postcss": "^8.3.3", "stylelint": "^17.0.0" }, "optionalPeers": ["postcss"] }, "sha512-x5DVehzJudcwF0od3sGpgkln2PLLranFE7twwbp7dqDINCyZvwzFkMc6TLhNOvazRiVBJYATQLouJY0xPGB8WA=="], "stylelint-config-sass-guidelines": ["stylelint-config-sass-guidelines@13.0.0", "", { "dependencies": { "@stylistic/stylelint-plugin": "^5.0.1", "postcss-scss": "^4.0.9", "stylelint-scss": "^7.0.0" }, "peerDependencies": { "postcss": "^8.4.21", "stylelint": "^17.1.0" } }, "sha512-YJT0X8h0OqyEo7ys3EycV5CGWt2rrkEYE8sHSN6sFnrxbXvHiy4KJFHDOWfyb3eWR6wtYpM+yIyvR2Plc8+pCg=="], @@ -1526,7 +1526,7 @@ "terser": ["terser@5.46.1", "", { "dependencies": { "@jridgewell/source-map": "^0.3.3", "acorn": "^8.15.0", "commander": "^2.20.0", "source-map-support": "~0.5.20" }, "bin": { "terser": "bin/terser" } }, "sha512-vzCjQO/rgUuK9sf8VJZvjqiqiHFaZLnOiimmUuOKODxWL8mm/xua7viT7aqX7dgPY60otQjUotzFMmCB4VdmqQ=="], - "tinyglobby": ["tinyglobby@0.2.15", "", { "dependencies": { "fdir": "^6.5.0", "picomatch": "^4.0.3" } }, "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ=="], + "tinyglobby": ["tinyglobby@0.2.16", "", { "dependencies": { "fdir": "^6.5.0", "picomatch": "^4.0.4" } }, "sha512-pn99VhoACYR8nFHhxqix+uvsbXineAasWm5ojXoN8xEwK5Kd3/TrhNn1wByuD52UxWRLy8pu+kRMniEi6Eq9Zg=="], "to-regex-range": ["to-regex-range@5.0.1", "", { "dependencies": { "is-number": "^7.0.0" } }, "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ=="], @@ -1562,7 +1562,7 @@ "unbox-primitive": ["unbox-primitive@1.1.0", "", { "dependencies": { "call-bound": "^1.0.3", "has-bigints": "^1.0.2", "has-symbols": "^1.1.0", "which-boxed-primitive": "^1.1.1" } }, "sha512-nWJ91DjeOkej/TA8pXQ3myruKpKEYgqvpw9lz4OPHj/NWFNluYrjbz9j01CJ8yKQd2g4jFoOkINCTW2I5LEEyw=="], - "undici-types": ["undici-types@7.18.2", "", {}, "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w=="], + "undici-types": ["undici-types@7.19.2", "", {}, "sha512-qYVnV5OEm2AW8cJMCpdV20CDyaN3g0AjDlOGf1OW4iaDEx8MwdtChUp4zu4H0VP3nDRF/8RKWH+IPp9uW0YGZg=="], "unicode-canonical-property-names-ecmascript": ["unicode-canonical-property-names-ecmascript@2.0.1", "", {}, "sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg=="], @@ -1588,7 +1588,7 @@ "varint": ["varint@6.0.0", "", {}, "sha512-cXEIW6cfr15lFv563k4GuVuW/fiwjknytD37jIOLSdSWuOI6WnO/oKwmP2FQTU2l01LP8/M5TSAJpzUaGe3uWg=="], - "vite": ["vite@8.0.7", "", { "dependencies": { "lightningcss": "^1.32.0", "picomatch": "^4.0.4", "postcss": "^8.5.8", "rolldown": "1.0.0-rc.13", "tinyglobby": "^0.2.15" }, "optionalDependencies": { "fsevents": "~2.3.3" }, "peerDependencies": { "@types/node": "^20.19.0 || >=22.12.0", "@vitejs/devtools": "^0.1.0", "esbuild": "^0.27.0 || ^0.28.0", "jiti": ">=1.21.0", "less": "^4.0.0", "sass": "^1.70.0", "sass-embedded": "^1.70.0", "stylus": ">=0.54.8", "sugarss": "^5.0.0", "terser": "^5.16.0", "tsx": "^4.8.1", "yaml": "^2.4.2" }, "optionalPeers": ["@types/node", "@vitejs/devtools", "esbuild", "jiti", "less", "sass", "sass-embedded", "stylus", "sugarss", "terser", "tsx", "yaml"], "bin": { "vite": "bin/vite.js" } }, "sha512-P1PbweD+2/udplnThz3btF4cf6AgPky7kk23RtHUkJIU5BIxwPprhRGmOAHs6FTI7UiGbTNrgNP6jSYD6JaRnw=="], + "vite": ["vite@8.0.8", "", { "dependencies": { "lightningcss": "^1.32.0", "picomatch": "^4.0.4", "postcss": "^8.5.8", "rolldown": "1.0.0-rc.15", "tinyglobby": "^0.2.15" }, "optionalDependencies": { "fsevents": "~2.3.3" }, "peerDependencies": { "@types/node": "^20.19.0 || >=22.12.0", "@vitejs/devtools": "^0.1.0", "esbuild": "^0.27.0 || ^0.28.0", "jiti": ">=1.21.0", "less": "^4.0.0", "sass": "^1.70.0", "sass-embedded": "^1.70.0", "stylus": ">=0.54.8", "sugarss": "^5.0.0", "terser": "^5.16.0", "tsx": "^4.8.1", "yaml": "^2.4.2" }, "optionalPeers": ["@types/node", "@vitejs/devtools", "esbuild", "jiti", "less", "sass", "sass-embedded", "stylus", "sugarss", "terser", "tsx", "yaml"], "bin": { "vite": "bin/vite.js" } }, "sha512-dbU7/iLVa8KZALJyLOBOQ88nOXtNG8vxKuOT4I2mD+Ya70KPceF4IAmDsmU0h1Qsn5bPrvsY9HJstCRh3hG6Uw=="], "vite-tsconfig-paths": ["vite-tsconfig-paths@6.1.1", "", { "dependencies": { "debug": "^4.1.1", "globrex": "^0.1.2", "tsconfck": "^3.0.3" }, "peerDependencies": { "vite": "*" } }, "sha512-2cihq7zliibCCZ8P9cKJrQBkfgdvcFkOOc3Y02o3GWUDLgqjWsZudaoiuOwO/gzTzy17cS5F7ZPo4bsnS4DGkg=="], @@ -1632,38 +1632,10 @@ "@eslint-community/eslint-utils/eslint-visitor-keys": ["eslint-visitor-keys@3.4.3", "", {}, "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag=="], - "@gcch/configuration-eslint/eslint": ["eslint@10.1.0", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.2", "@eslint/config-array": "^0.23.3", "@eslint/config-helpers": "^0.5.3", "@eslint/core": "^1.1.1", "@eslint/plugin-kit": "^0.6.1", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", "@humanwhocodes/retry": "^0.4.2", "@types/estree": "^1.0.6", "ajv": "^6.14.0", "cross-spawn": "^7.0.6", "debug": "^4.3.2", "escape-string-regexp": "^4.0.0", "eslint-scope": "^9.1.2", "eslint-visitor-keys": "^5.0.1", "espree": "^11.2.0", "esquery": "^1.7.0", "esutils": "^2.0.2", "fast-deep-equal": "^3.1.3", "file-entry-cache": "^8.0.0", "find-up": "^5.0.0", "glob-parent": "^6.0.2", "ignore": "^5.2.0", "imurmurhash": "^0.1.4", "is-glob": "^4.0.0", "json-stable-stringify-without-jsonify": "^1.0.1", "minimatch": "^10.2.4", "natural-compare": "^1.4.0", "optionator": "^0.9.3" }, "peerDependencies": { "jiti": "*" }, "optionalPeers": ["jiti"], "bin": { "eslint": "bin/eslint.js" } }, "sha512-S9jlY/ELKEUwwQnqWDO+f+m6sercqOPSqXM5Go94l7DOmxHVDgmSFGWEzeE/gwgTAr0W103BWt0QLe/7mabIvA=="], - - "@gcch/configuration-eslint/typescript-eslint": ["typescript-eslint@8.58.0", "", { "dependencies": { "@typescript-eslint/eslint-plugin": "8.58.0", "@typescript-eslint/parser": "8.58.0", "@typescript-eslint/typescript-estree": "8.58.0", "@typescript-eslint/utils": "8.58.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-e2TQzKfaI85fO+F3QywtX+tCTsu/D3WW5LVU6nz8hTFKFZ8yBJ6mSYRpXqdR3mFjPWmO0eWsTa5f+UpAOe/FMA=="], - - "@gcch/configuration-prettier/prettier-plugin-sh": ["prettier-plugin-sh@0.18.0", "", { "dependencies": { "@reteps/dockerfmt": "^0.3.6", "sh-syntax": "^0.5.8" }, "peerDependencies": { "prettier": "^3.6.0" } }, "sha512-cW1XL27FOJQ/qGHOW6IHwdCiNWQsAgK+feA8V6+xUTaH0cD3Mh+tFAtBvEEWvuY6hTDzRV943Fzeii+qMOh7nQ=="], - "@keyv/bigmap/keyv": ["keyv@5.6.0", "", { "dependencies": { "@keyv/serialize": "^1.1.1" } }, "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw=="], - "@typescript-eslint/eslint-plugin/@typescript-eslint/scope-manager": ["@typescript-eslint/scope-manager@8.58.1", "", { "dependencies": { "@typescript-eslint/types": "8.58.1", "@typescript-eslint/visitor-keys": "8.58.1" } }, "sha512-TPYUEqJK6avLcEjumWsIuTpuYODTTDAtoMdt8ZZa93uWMTX13Nb8L5leSje1NluammvU+oI3QRr5lLXPgihX3w=="], - - "@typescript-eslint/eslint-plugin/@typescript-eslint/type-utils": ["@typescript-eslint/type-utils@8.58.1", "", { "dependencies": { "@typescript-eslint/types": "8.58.1", "@typescript-eslint/typescript-estree": "8.58.1", "@typescript-eslint/utils": "8.58.1", "debug": "^4.4.3", "ts-api-utils": "^2.5.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-HUFxvTJVroT+0rXVJC7eD5zol6ID+Sn5npVPWoFuHGg9Ncq5Q4EYstqR+UOqaNRFXi5TYkpXXkLhoCHe3G0+7w=="], - - "@typescript-eslint/eslint-plugin/@typescript-eslint/utils": ["@typescript-eslint/utils@8.58.1", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.9.1", "@typescript-eslint/scope-manager": "8.58.1", "@typescript-eslint/types": "8.58.1", "@typescript-eslint/typescript-estree": "8.58.1" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-Ln8R0tmWC7pTtLOzgJzYTXSCjJ9rDNHAqTaVONF4FEi2qwce8mD9iSOxOpLFFvWp/wBFlew0mjM1L1ihYWfBdQ=="], - "@typescript-eslint/eslint-plugin/ignore": ["ignore@7.0.5", "", {}, "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg=="], - "@typescript-eslint/parser/@typescript-eslint/scope-manager": ["@typescript-eslint/scope-manager@8.58.1", "", { "dependencies": { "@typescript-eslint/types": "8.58.1", "@typescript-eslint/visitor-keys": "8.58.1" } }, "sha512-TPYUEqJK6avLcEjumWsIuTpuYODTTDAtoMdt8ZZa93uWMTX13Nb8L5leSje1NluammvU+oI3QRr5lLXPgihX3w=="], - - "@typescript-eslint/parser/@typescript-eslint/types": ["@typescript-eslint/types@8.58.1", "", {}, "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw=="], - - "@typescript-eslint/project-service/@typescript-eslint/types": ["@typescript-eslint/types@8.58.1", "", {}, "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw=="], - - "@typescript-eslint/scope-manager/@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.58.0", "", { "dependencies": { "@typescript-eslint/types": "8.58.0", "eslint-visitor-keys": "^5.0.0" } }, "sha512-XJ9UD9+bbDo4a4epraTwG3TsNPeiB9aShrUneAVXy8q4LuwowN+qu89/6ByLMINqvIMeI9H9hOHQtg/ijrYXzQ=="], - - "@typescript-eslint/type-utils/@typescript-eslint/typescript-estree": ["@typescript-eslint/typescript-estree@8.58.0", "", { "dependencies": { "@typescript-eslint/project-service": "8.58.0", "@typescript-eslint/tsconfig-utils": "8.58.0", "@typescript-eslint/types": "8.58.0", "@typescript-eslint/visitor-keys": "8.58.0", "debug": "^4.4.3", "minimatch": "^10.2.2", "semver": "^7.7.3", "tinyglobby": "^0.2.15", "ts-api-utils": "^2.5.0" }, "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-7vv5UWbHqew/dvs+D3e1RvLv1v2eeZ9txRHPnEEBUgSNLx5ghdzjHa0sgLWYVKssH+lYmV0JaWdoubo0ncGYLA=="], - - "@typescript-eslint/typescript-estree/@typescript-eslint/types": ["@typescript-eslint/types@8.58.1", "", {}, "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw=="], - - "@typescript-eslint/utils/@typescript-eslint/typescript-estree": ["@typescript-eslint/typescript-estree@8.58.0", "", { "dependencies": { "@typescript-eslint/project-service": "8.58.0", "@typescript-eslint/tsconfig-utils": "8.58.0", "@typescript-eslint/types": "8.58.0", "@typescript-eslint/visitor-keys": "8.58.0", "debug": "^4.4.3", "minimatch": "^10.2.2", "semver": "^7.7.3", "tinyglobby": "^0.2.15", "ts-api-utils": "^2.5.0" }, "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-7vv5UWbHqew/dvs+D3e1RvLv1v2eeZ9txRHPnEEBUgSNLx5ghdzjHa0sgLWYVKssH+lYmV0JaWdoubo0ncGYLA=="], - - "@typescript-eslint/visitor-keys/@typescript-eslint/types": ["@typescript-eslint/types@8.58.1", "", {}, "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw=="], - "astro-eslint-parser/eslint-scope": ["eslint-scope@8.4.0", "", { "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^5.2.0" } }, "sha512-sNXOfKCn74rt8RICKMvJS7XKV/Xk9kA7DyJr8mJik3S7Cwgy3qlkkmyS2uQB3jiJg6VNdZd/pDBJu0nvG2NlTg=="], "astro-eslint-parser/eslint-visitor-keys": ["eslint-visitor-keys@4.2.1", "", {}, "sha512-Uhdk5sfqcee/9H/rCOJikYz67o0a2Tw2hGRPOG2Y1R2dg7brRe1uG0yaNQDHu+TO/uQPF/5eCapvYSmHUjt7JQ=="], @@ -1672,8 +1644,6 @@ "babel-plugin-polyfill-corejs2/semver": ["semver@6.3.1", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA=="], - "browserslist/caniuse-lite": ["caniuse-lite@1.0.30001784", "", {}, "sha512-WU346nBTklUV9YfUl60fqRbU5ZqyXlqvo1SgigE1OAXK5bFL8LL9q1K7aap3N739l4BvNqnkm3YrGHiY9sfUQw=="], - "browserslist-to-esbuild/meow": ["meow@13.2.0", "", {}, "sha512-pxQJQzB6djGPXh08dacEloMFopsOqGVRKFPYvPOt9XDZ1HasbgDZA74CJGreSU4G3Ak7EFJGoiH2auq+yXISgA=="], "cacheable/keyv": ["keyv@5.6.0", "", { "dependencies": { "@keyv/serialize": "^1.1.1" } }, "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw=="], @@ -1702,7 +1672,7 @@ "qified/hookified": ["hookified@2.1.1", "", {}, "sha512-AHb76R16GB5EsPBE2J7Ko5kiEyXwviB9P5SMrAKcuAu4vJPZttViAbj9+tZeaQE5zjDme+1vcHP78Yj/WoAveA=="], - "rolldown/@oxc-project/types": ["@oxc-project/types@0.123.0", "", {}, "sha512-YtECP/y8Mj1lSHiUWGSRzy/C6teUKlS87dEfuVKT09LgQbUsBW1rNg+MiJ4buGu3yuADV60gbIvo9/HplA56Ew=="], + "rolldown/@oxc-project/types": ["@oxc-project/types@0.124.0", "", {}, "sha512-VBFWMTBvHxS11Z5Lvlr3IWgrwhMTXV+Md+EQF0Xf60+wAdsGFTBx7X7K/hP4pi8N7dcm1RvcHwDxZ16Qx8keUg=="], "stylelint/file-entry-cache": ["file-entry-cache@11.1.2", "", { "dependencies": { "flat-cache": "^6.1.20" } }, "sha512-N2WFfK12gmrK1c1GXOqiAJ1tc5YE+R53zvQ+t5P8S5XhnmKYVB5eZEiLNZKDSmoG8wqqbF9EXYBBW/nef19log=="], @@ -1718,44 +1688,8 @@ "table/strip-ansi": ["strip-ansi@6.0.1", "", { "dependencies": { "ansi-regex": "^5.0.1" } }, "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A=="], - "typescript-eslint/@typescript-eslint/utils": ["@typescript-eslint/utils@8.58.1", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.9.1", "@typescript-eslint/scope-manager": "8.58.1", "@typescript-eslint/types": "8.58.1", "@typescript-eslint/typescript-estree": "8.58.1" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-Ln8R0tmWC7pTtLOzgJzYTXSCjJ9rDNHAqTaVONF4FEi2qwce8mD9iSOxOpLFFvWp/wBFlew0mjM1L1ihYWfBdQ=="], - "vite/fsevents": ["fsevents@2.3.3", "", { "os": "darwin" }, "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw=="], - "@gcch/configuration-eslint/eslint/@eslint/config-array": ["@eslint/config-array@0.23.3", "", { "dependencies": { "@eslint/object-schema": "^3.0.3", "debug": "^4.3.1", "minimatch": "^10.2.4" } }, "sha512-j+eEWmB6YYLwcNOdlwQ6L2OsptI/LO6lNBuLIqe5R7RetD658HLoF+Mn7LzYmAWWNNzdC6cqP+L6r8ujeYXWLw=="], - - "@gcch/configuration-eslint/eslint/@eslint/config-helpers": ["@eslint/config-helpers@0.5.3", "", { "dependencies": { "@eslint/core": "^1.1.1" } }, "sha512-lzGN0onllOZCGroKJmRwY6QcEHxbjBw1gwB8SgRSqK8YbbtEXMvKynsXc3553ckIEBxsbMBU7oOZXKIPGZNeZw=="], - - "@gcch/configuration-eslint/eslint/@eslint/core": ["@eslint/core@1.1.1", "", { "dependencies": { "@types/json-schema": "^7.0.15" } }, "sha512-QUPblTtE51/7/Zhfv8BDwO0qkkzQL7P/aWWbqcf4xWLEYn1oKjdO0gglQBB4GAsu7u6wjijbCmzsUTy6mnk6oQ=="], - - "@gcch/configuration-eslint/eslint/@eslint/plugin-kit": ["@eslint/plugin-kit@0.6.1", "", { "dependencies": { "@eslint/core": "^1.1.1", "levn": "^0.4.1" } }, "sha512-iH1B076HoAshH1mLpHMgwdGeTs0CYwL0SPMkGuSebZrwBp16v415e9NZXg2jtrqPVQjf6IANe2Vtlr5KswtcZQ=="], - - "@gcch/configuration-eslint/typescript-eslint/@typescript-eslint/eslint-plugin": ["@typescript-eslint/eslint-plugin@8.58.0", "", { "dependencies": { "@eslint-community/regexpp": "^4.12.2", "@typescript-eslint/scope-manager": "8.58.0", "@typescript-eslint/type-utils": "8.58.0", "@typescript-eslint/utils": "8.58.0", "@typescript-eslint/visitor-keys": "8.58.0", "ignore": "^7.0.5", "natural-compare": "^1.4.0", "ts-api-utils": "^2.5.0" }, "peerDependencies": { "@typescript-eslint/parser": "^8.58.0", "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-RLkVSiNuUP1C2ROIWfqX+YcUfLaSnxGE/8M+Y57lopVwg9VTYYfhuz15Yf1IzCKgZj6/rIbYTmJCUSqr76r0Wg=="], - - "@gcch/configuration-eslint/typescript-eslint/@typescript-eslint/parser": ["@typescript-eslint/parser@8.58.0", "", { "dependencies": { "@typescript-eslint/scope-manager": "8.58.0", "@typescript-eslint/types": "8.58.0", "@typescript-eslint/typescript-estree": "8.58.0", "@typescript-eslint/visitor-keys": "8.58.0", "debug": "^4.4.3" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-rLoGZIf9afaRBYsPUMtvkDWykwXwUPL60HebR4JgTI8mxfFe2cQTu3AGitANp4b9B2QlVru6WzjgB2IzJKiCSA=="], - - "@gcch/configuration-eslint/typescript-eslint/@typescript-eslint/typescript-estree": ["@typescript-eslint/typescript-estree@8.58.0", "", { "dependencies": { "@typescript-eslint/project-service": "8.58.0", "@typescript-eslint/tsconfig-utils": "8.58.0", "@typescript-eslint/types": "8.58.0", "@typescript-eslint/visitor-keys": "8.58.0", "debug": "^4.4.3", "minimatch": "^10.2.2", "semver": "^7.7.3", "tinyglobby": "^0.2.15", "ts-api-utils": "^2.5.0" }, "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-7vv5UWbHqew/dvs+D3e1RvLv1v2eeZ9txRHPnEEBUgSNLx5ghdzjHa0sgLWYVKssH+lYmV0JaWdoubo0ncGYLA=="], - - "@gcch/configuration-prettier/prettier-plugin-sh/@reteps/dockerfmt": ["@reteps/dockerfmt@0.3.6", "", {}, "sha512-Tb5wIMvBf/nLejTQ61krK644/CEMB/cpiaIFXqGApfGqO3GwcR3qnI0DbmkFVCl2OyEp8LnLX3EkucoL0+tbFg=="], - - "@typescript-eslint/eslint-plugin/@typescript-eslint/scope-manager/@typescript-eslint/types": ["@typescript-eslint/types@8.58.1", "", {}, "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw=="], - - "@typescript-eslint/eslint-plugin/@typescript-eslint/type-utils/@typescript-eslint/types": ["@typescript-eslint/types@8.58.1", "", {}, "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw=="], - - "@typescript-eslint/eslint-plugin/@typescript-eslint/utils/@typescript-eslint/types": ["@typescript-eslint/types@8.58.1", "", {}, "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw=="], - - "@typescript-eslint/type-utils/@typescript-eslint/typescript-estree/@typescript-eslint/project-service": ["@typescript-eslint/project-service@8.58.0", "", { "dependencies": { "@typescript-eslint/tsconfig-utils": "^8.58.0", "@typescript-eslint/types": "^8.58.0", "debug": "^4.4.3" }, "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-8Q/wBPWLQP1j16NxoPNIKpDZFMaxl7yWIoqXWYeWO+Bbd2mjgvoF0dxP2jKZg5+x49rgKdf7Ck473M8PC3V9lg=="], - - "@typescript-eslint/type-utils/@typescript-eslint/typescript-estree/@typescript-eslint/tsconfig-utils": ["@typescript-eslint/tsconfig-utils@8.58.0", "", { "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-doNSZEVJsWEu4htiVC+PR6NpM+pa+a4ClH9INRWOWCUzMst/VA9c4gXq92F8GUD1rwhNvRLkgjfYtFXegXQF7A=="], - - "@typescript-eslint/type-utils/@typescript-eslint/typescript-estree/@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.58.0", "", { "dependencies": { "@typescript-eslint/types": "8.58.0", "eslint-visitor-keys": "^5.0.0" } }, "sha512-XJ9UD9+bbDo4a4epraTwG3TsNPeiB9aShrUneAVXy8q4LuwowN+qu89/6ByLMINqvIMeI9H9hOHQtg/ijrYXzQ=="], - - "@typescript-eslint/utils/@typescript-eslint/typescript-estree/@typescript-eslint/project-service": ["@typescript-eslint/project-service@8.58.0", "", { "dependencies": { "@typescript-eslint/tsconfig-utils": "^8.58.0", "@typescript-eslint/types": "^8.58.0", "debug": "^4.4.3" }, "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-8Q/wBPWLQP1j16NxoPNIKpDZFMaxl7yWIoqXWYeWO+Bbd2mjgvoF0dxP2jKZg5+x49rgKdf7Ck473M8PC3V9lg=="], - - "@typescript-eslint/utils/@typescript-eslint/typescript-estree/@typescript-eslint/tsconfig-utils": ["@typescript-eslint/tsconfig-utils@8.58.0", "", { "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-doNSZEVJsWEu4htiVC+PR6NpM+pa+a4ClH9INRWOWCUzMst/VA9c4gXq92F8GUD1rwhNvRLkgjfYtFXegXQF7A=="], - - "@typescript-eslint/utils/@typescript-eslint/typescript-estree/@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.58.0", "", { "dependencies": { "@typescript-eslint/types": "8.58.0", "eslint-visitor-keys": "^5.0.0" } }, "sha512-XJ9UD9+bbDo4a4epraTwG3TsNPeiB9aShrUneAVXy8q4LuwowN+qu89/6ByLMINqvIMeI9H9hOHQtg/ijrYXzQ=="], - "eslint-plugin-jsx-a11y/minimatch/brace-expansion": ["brace-expansion@1.1.13", "", { "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "sha512-9ZLprWS6EENmhEOpjCYW2c8VkmOvckIJZfkr7rBW6dObmfgJ/L1GpSYW5Hpo9lDz4D1+n0Ckz8rU7FwHDQiG/w=="], "stylelint/file-entry-cache/flat-cache": ["flat-cache@6.1.22", "", { "dependencies": { "cacheable": "^2.3.4", "flatted": "^3.4.2", "hookified": "^1.15.0" } }, "sha512-N2dnzVJIphnNsjHcrxGW7DePckJ6haPrSFqpsBUhHYgwtKGVq4JrBGielEGD2fCVnsGm1zlBVZ8wGhkyuetgug=="], @@ -1766,24 +1700,6 @@ "table/strip-ansi/ansi-regex": ["ansi-regex@5.0.1", "", {}, "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ=="], - "typescript-eslint/@typescript-eslint/utils/@typescript-eslint/scope-manager": ["@typescript-eslint/scope-manager@8.58.1", "", { "dependencies": { "@typescript-eslint/types": "8.58.1", "@typescript-eslint/visitor-keys": "8.58.1" } }, "sha512-TPYUEqJK6avLcEjumWsIuTpuYODTTDAtoMdt8ZZa93uWMTX13Nb8L5leSje1NluammvU+oI3QRr5lLXPgihX3w=="], - - "typescript-eslint/@typescript-eslint/utils/@typescript-eslint/types": ["@typescript-eslint/types@8.58.1", "", {}, "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw=="], - - "@gcch/configuration-eslint/eslint/@eslint/config-array/@eslint/object-schema": ["@eslint/object-schema@3.0.3", "", {}, "sha512-iM869Pugn9Nsxbh/YHRqYiqd23AmIbxJOcpUMOuWCVNdoQJ5ZtwL6h3t0bcZzJUlC3Dq9jCFCESBZnX0GTv7iQ=="], - - "@gcch/configuration-eslint/typescript-eslint/@typescript-eslint/eslint-plugin/@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.58.0", "", { "dependencies": { "@typescript-eslint/types": "8.58.0", "eslint-visitor-keys": "^5.0.0" } }, "sha512-XJ9UD9+bbDo4a4epraTwG3TsNPeiB9aShrUneAVXy8q4LuwowN+qu89/6ByLMINqvIMeI9H9hOHQtg/ijrYXzQ=="], - - "@gcch/configuration-eslint/typescript-eslint/@typescript-eslint/eslint-plugin/ignore": ["ignore@7.0.5", "", {}, "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg=="], - - "@gcch/configuration-eslint/typescript-eslint/@typescript-eslint/parser/@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.58.0", "", { "dependencies": { "@typescript-eslint/types": "8.58.0", "eslint-visitor-keys": "^5.0.0" } }, "sha512-XJ9UD9+bbDo4a4epraTwG3TsNPeiB9aShrUneAVXy8q4LuwowN+qu89/6ByLMINqvIMeI9H9hOHQtg/ijrYXzQ=="], - - "@gcch/configuration-eslint/typescript-eslint/@typescript-eslint/typescript-estree/@typescript-eslint/project-service": ["@typescript-eslint/project-service@8.58.0", "", { "dependencies": { "@typescript-eslint/tsconfig-utils": "^8.58.0", "@typescript-eslint/types": "^8.58.0", "debug": "^4.4.3" }, "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-8Q/wBPWLQP1j16NxoPNIKpDZFMaxl7yWIoqXWYeWO+Bbd2mjgvoF0dxP2jKZg5+x49rgKdf7Ck473M8PC3V9lg=="], - - "@gcch/configuration-eslint/typescript-eslint/@typescript-eslint/typescript-estree/@typescript-eslint/tsconfig-utils": ["@typescript-eslint/tsconfig-utils@8.58.0", "", { "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-doNSZEVJsWEu4htiVC+PR6NpM+pa+a4ClH9INRWOWCUzMst/VA9c4gXq92F8GUD1rwhNvRLkgjfYtFXegXQF7A=="], - - "@gcch/configuration-eslint/typescript-eslint/@typescript-eslint/typescript-estree/@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.58.0", "", { "dependencies": { "@typescript-eslint/types": "8.58.0", "eslint-visitor-keys": "^5.0.0" } }, "sha512-XJ9UD9+bbDo4a4epraTwG3TsNPeiB9aShrUneAVXy8q4LuwowN+qu89/6ByLMINqvIMeI9H9hOHQtg/ijrYXzQ=="], - "eslint-plugin-jsx-a11y/minimatch/brace-expansion/balanced-match": ["balanced-match@1.0.2", "", {}, "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="], } } diff --git a/cfg/oxlint.config.ts b/cfg/oxlint.config.ts index ae0a50aa..13bceee2 100644 --- a/cfg/oxlint.config.ts +++ b/cfg/oxlint.config.ts @@ -1,5 +1,5 @@ import gcchConfig from "@gcch/configuration-oxlint"; -import { OxlintConfig } from "oxlint"; +import type { OxlintConfig } from "oxlint"; const config: OxlintConfig = { ...gcchConfig, diff --git a/cfg/playwright.config.ts b/cfg/playwright.config.ts index c27c1459..5ea6eced 100644 --- a/cfg/playwright.config.ts +++ b/cfg/playwright.config.ts @@ -5,7 +5,7 @@ export default defineConfig({ projects: [ { name: "desktop-chromium-1920", - use: { ...devices["Desktop Chrome"], viewport: { width: 1920, height: 1080 } }, + use: { ...devices["Desktop Chrome"], viewport: { height: 1080, width: 1920 } }, }, // { // name: "desktop-chromium-1536", @@ -17,7 +17,7 @@ export default defineConfig({ // }, { name: "desktop-firefox-1920", - use: { ...devices["Desktop Firefox"], viewport: { width: 1920, height: 1080 } }, + use: { ...devices["Desktop Firefox"], viewport: { height: 1080, width: 1920 } }, }, // { // name: "desktop-firefox-1536", @@ -51,7 +51,6 @@ export default defineConfig({ use: { /* Base URL to use in actions like `await page.goto('/')`. */ baseURL: "https://haikuatelier.gcch.local", - trace: "retry-with-trace", clientCertificates: [ { origin: "https://haikuatelier.gcch.local", @@ -60,6 +59,7 @@ export default defineConfig({ }, ], ignoreHTTPSErrors: true, + trace: "retry-with-trace", }, workers: "100%", }); diff --git a/cfg/stylelint.config.ts b/cfg/stylelint.config.ts index 29c371b0..c2a5a9dd 100755 --- a/cfg/stylelint.config.ts +++ b/cfg/stylelint.config.ts @@ -1,4 +1,4 @@ -import { pipe, Array as FxArray } from "effect"; +import { Array as FxArray, pipe } from "effect"; import type stylelint from "stylelint"; import { propertyGroups } from "stylelint-config-clean-order"; diff --git a/composer.json b/composer.json index a108182d..7accacd9 100755 --- a/composer.json +++ b/composer.json @@ -1,9 +1,4 @@ { - "autoload": { - "psr-4": { - "HaikuAtelier\\": "web/app/themes/haiku-atelier-2024/src/inc/" - } - }, "authors": [ { "email": "scott.walkinshaw@gmail.com", @@ -16,6 +11,11 @@ "name": "Ben Word" } ], + "autoload": { + "psr-4": { + "HaikuAtelier\\": "web/app/themes/haiku-atelier-2024/src/inc/" + } + }, "config": { "allow-plugins": { "carthage-software/mago": true, @@ -31,28 +31,45 @@ "description": "WordPress boilerplate with Composer, easier configuration, and an improved folder structure", "extra": { "installer-paths": { - "web/app/mu-plugins/{$name}/": ["type:wordpress-muplugin"], - "web/app/plugins/{$name}/": ["type:wordpress-plugin"], - "web/app/themes/{$name}/": ["type:wordpress-theme"], - "web/vendor/{$vendor}/{$name}": ["htmlburger/carbon-fields"] + "web/app/mu-plugins/{$name}/": [ + "type:wordpress-muplugin" + ], + "web/app/plugins/{$name}/": [ + "type:wordpress-plugin" + ], + "web/app/themes/{$name}/": [ + "type:wordpress-theme" + ], + "web/vendor/{$vendor}/{$name}": [ + "htmlburger/carbon-fields" + ] }, "wordpress-install-dir": "web/wp" }, "homepage": "https://roots.io/bedrock/", - "keywords": ["bedrock", "composer", "roots", "wordpress", "wp", "wp-config"], + "keywords": [ + "bedrock", + "composer", + "roots", + "wordpress", + "wp", + "wp-config" + ], "license": "MIT", "minimum-stability": "dev", "name": "roots/bedrock", "prefer-stable": true, "repositories": [ { - "only": ["wpackagist-plugin/*", "wpackagist-theme/*"], + "only": [ + "wpackagist-plugin/*", + "wpackagist-theme/*" + ], "type": "composer", "url": "https://wpackagist.org" } ], "require": { - "php": ">=8.5", "composer/installers": "^2.3", "crell/fp": "^1.0", "htmlburger/carbon-fields": "^3.6.9", @@ -63,10 +80,11 @@ "mnsami/composer-custom-directory-installer": "^2.0", "nesbot/carbon": "^3.11.3", "oscarotero/env": "^2.1.1", + "php": ">=8.5", + "php-standard-library/php-standard-library": "^6.1.1", "roots/bedrock-autoloader": "^1.1.0", "roots/bedrock-disallow-indexing": "^2.1", "roots/wordpress": "^6.9.4", - "php-standard-library/php-standard-library": "^6.1.1", "roots/wp-config": "^1.0", "stripe/stripe-php": "^19.4.1", "symfony/uid": "^8.0.8", diff --git a/composer.lock b/composer.lock index ff04a496..3efc525e 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "8fa8994b91f6fdfb99db59a67eb54ac5", + "content-hash": "bf6e098198b957782555eeb97479b37e", "packages": [ { "name": "carbonphp/carbon-doctrine-types", @@ -5129,12 +5129,12 @@ "source": { "type": "git", "url": "https://github.com/Roave/SecurityAdvisories.git", - "reference": "7c570124dcf5c6834d78348d6817f32cd6b537d7" + "reference": "d830a949e5c180e97c2245221daf8b589552cc2c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Roave/SecurityAdvisories/zipball/7c570124dcf5c6834d78348d6817f32cd6b537d7", - "reference": "7c570124dcf5c6834d78348d6817f32cd6b537d7", + "url": "https://api.github.com/repos/Roave/SecurityAdvisories/zipball/d830a949e5c180e97c2245221daf8b589552cc2c", + "reference": "d830a949e5c180e97c2245221daf8b589552cc2c", "shasum": "" }, "conflict": { @@ -5190,7 +5190,6 @@ "auth0/wordpress": "<=5.5", "automad/automad": "<2.0.0.0-alpha5", "automattic/jetpack": "<9.8", - "avideo/avideo": "<=26", "awesome-support/awesome-support": "<=6.0.7", "aws/aws-sdk-php": "<=3.371.3", "ayacoo/redirect-tab": "<2.1.2|>=3,<3.1.7|>=4,<4.0.5", @@ -5249,7 +5248,7 @@ "cesnet/simplesamlphp-module-proxystatistics": "<3.1", "chriskacerguis/codeigniter-restserver": "<=2.7.1", "chrome-php/chrome": "<1.14", - "ci4-cms-erp/ci4ms": "<=0.31.1", + "ci4-cms-erp/ci4ms": "<=0.31.3", "civicrm/civicrm-core": ">=4.2,<4.2.9|>=4.3,<4.3.3", "ckeditor/ckeditor": "<4.25", "clickstorm/cs-seo": ">=6,<6.8|>=7,<7.5|>=8,<8.4|>=9,<9.3", @@ -5544,6 +5543,7 @@ "juzaweb/cms": "<=3.4.2", "jweiland/events2": "<8.3.8|>=9,<9.0.6", "jweiland/kk-downloader": "<1.2.2", + "kantorge/yaffa": "<=2", "kazist/phpwhois": "<=4.2.6", "kelvinmo/simplejwt": "<=1.1", "kelvinmo/simplexrd": "<3.1.1", @@ -5567,6 +5567,7 @@ "laravel/fortify": "<1.11.1", "laravel/framework": "<10.48.29|>=11,<11.44.1|>=12,<12.1.1", "laravel/laravel": ">=5.4,<5.4.22", + "laravel/passport": "<13.7.1", "laravel/pulse": "<1.3.1", "laravel/reverb": "<1.7", "laravel/socialite": ">=1,<2.0.10", @@ -5747,7 +5748,7 @@ "phpoffice/phpexcel": "<=1.8.2", "phpoffice/phpspreadsheet": "<1.30|>=2,<2.1.12|>=2.2,<2.4|>=3,<3.10|>=4,<5", "phppgadmin/phppgadmin": "<=7.13", - "phpseclib/phpseclib": "<=2.0.51|>=3,<=3.0.49", + "phpseclib/phpseclib": "<2.0.53|>=3,<3.0.51", "phpservermon/phpservermon": "<3.6", "phpsysinfo/phpsysinfo": "<3.4.3", "phpunit/phpunit": "<8.5.52|>=9,<9.6.33|>=10,<10.5.62|>=11,<11.5.50|>=12,<12.5.8", @@ -5809,11 +5810,11 @@ "rap2hpoutre/laravel-log-viewer": "<0.13", "react/http": ">=0.7,<1.9", "really-simple-plugins/complianz-gdpr": "<6.4.2", - "redaxo/source": "<=5.20.1", + "redaxo/source": "<5.21", "remdex/livehelperchat": "<4.29", "renolit/reint-downloadmanager": "<4.0.2|>=5,<5.0.1", "reportico-web/reportico": "<=8.1", - "rhukster/dom-sanitizer": "<1.0.7", + "rhukster/dom-sanitizer": "<1.0.10", "rmccue/requests": ">=1.6,<1.8", "roadiz/documents": "<2.3.42|>=2.4,<2.5.44|>=2.6,<2.6.28|>=2.7,<2.7.9", "robrichards/xmlseclibs": "<3.1.5", @@ -6171,7 +6172,7 @@ "type": "tidelift" } ], - "time": "2026-04-06T23:13:58+00:00" + "time": "2026-04-10T21:13:58+00:00" }, { "name": "sebastian/diff", @@ -7410,16 +7411,16 @@ }, { "name": "webmozart/assert", - "version": "2.1.6", + "version": "2.2.0", "source": { "type": "git", "url": "https://github.com/webmozarts/assert.git", - "reference": "ff31ad6efc62e66e518fbab1cde3453d389bcdc8" + "reference": "1b99650e7ffcad232624a260bc7fbdec2ffc407c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/webmozarts/assert/zipball/ff31ad6efc62e66e518fbab1cde3453d389bcdc8", - "reference": "ff31ad6efc62e66e518fbab1cde3453d389bcdc8", + "url": "https://api.github.com/repos/webmozarts/assert/zipball/1b99650e7ffcad232624a260bc7fbdec2ffc407c", + "reference": "1b99650e7ffcad232624a260bc7fbdec2ffc407c", "shasum": "" }, "require": { @@ -7466,9 +7467,9 @@ ], "support": { "issues": "https://github.com/webmozarts/assert/issues", - "source": "https://github.com/webmozarts/assert/tree/2.1.6" + "source": "https://github.com/webmozarts/assert/tree/2.2.0" }, - "time": "2026-02-27T10:28:38+00:00" + "time": "2026-04-09T16:54:47+00:00" } ], "aliases": [], @@ -7483,5 +7484,5 @@ "php": ">=8.5" }, "platform-dev": {}, - "plugin-api-version": "2.9.0" + "plugin-api-version": "2.6.0" } diff --git a/config/application.php b/config/application.php index bc828422..d175ad5c 100755 --- a/config/application.php +++ b/config/application.php @@ -37,16 +37,16 @@ $webroot_dir = $root_dir . '/web'; * .env.local will override .env if it exists */ if (file_exists($root_dir . '/.env')) { - $env_files = file_exists($root_dir . '/.env.local') ? ['.env', '.env.local'] : ['.env']; + $env_files = file_exists($root_dir . '/.env.local') ? ['.env', '.env.local'] : ['.env']; - $dotenv = Dotenv\Dotenv::createImmutable($root_dir, $env_files, false); + $dotenv = Dotenv\Dotenv::createImmutable($root_dir, $env_files, false); - $dotenv->load(); + $dotenv->load(); - $dotenv->required(['WP_HOME', 'WP_SITEURL']); - if (!env('DATABASE_URL')) { - $dotenv->required(['DB_NAME', 'DB_USER', 'DB_PASSWORD']); - } + $dotenv->required(['WP_HOME', 'WP_SITEURL']); + if (!env('DATABASE_URL')) { + $dotenv->required(['DB_NAME', 'DB_USER', 'DB_PASSWORD']); + } } /* @@ -57,7 +57,7 @@ define('WP_ENV', env('WP_ENV') ?: 'production'); // Infer WP_ENVIRONMENT_TYPE based on WP_ENV if (!env('WP_ENVIRONMENT_TYPE') && in_array(WP_ENV, ['production', 'staging', 'development', 'local'], true)) { - Config::define('WP_ENVIRONMENT_TYPE', WP_ENV); + Config::define('WP_ENVIRONMENT_TYPE', WP_ENV); } // URLs @@ -71,7 +71,7 @@ Config::define('WP_CONTENT_URL', Config::get('WP_HOME') . Config::get('CONTENT_D // DB settings if (env('DB_SSL')) { - Config::define('MYSQL_CLIENT_FLAGS', MYSQLI_CLIENT_SSL); + Config::define('MYSQL_CLIENT_FLAGS', MYSQLI_CLIENT_SSL); } Config::define('DB_NAME', env('DB_NAME')); @@ -83,12 +83,12 @@ Config::define('DB_COLLATE', ''); $table_prefix = env('DB_PREFIX') ?: 'wp_'; if (env('DATABASE_URL')) { - $dsn = (object) parse_url(env('DATABASE_URL')); + $dsn = (object) parse_url(env('DATABASE_URL')); - Config::define('DB_NAME', mb_substr($dsn->path, 1)); - Config::define('DB_USER', $dsn->user); - Config::define('DB_PASSWORD', $dsn->pass ?? null); - Config::define('DB_HOST', isset($dsn->port) ? "{$dsn->host}:{$dsn->port}" : $dsn->host); + Config::define('DB_NAME', mb_substr($dsn->path, 1)); + Config::define('DB_USER', $dsn->user); + Config::define('DB_PASSWORD', $dsn->pass ?? null); + Config::define('DB_HOST', isset($dsn->port) ? "{$dsn->host}:{$dsn->port}" : $dsn->host); } // Authentication Unique Keys and Salts @@ -129,18 +129,18 @@ Config::define('WP_PLUGIN_DIR', Config::get('WP_CONTENT_DIR') . '/plugins'); * See https://codex.wordpress.org/Function_Reference/is_ssl#Notes */ if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && 'https' === $_SERVER['HTTP_X_FORWARDED_PROTO']) { - $_SERVER['HTTPS'] = 'on'; + $_SERVER['HTTPS'] = 'on'; } $env_config = __DIR__ . '/environments/' . WP_ENV . '.php'; if (file_exists($env_config)) { - include_once $env_config; + include_once $env_config; } Config::apply(); // Bootstrap WordPress if (!defined('ABSPATH')) { - define('ABSPATH', $webroot_dir . '/wp/'); + define('ABSPATH', $webroot_dir . '/wp/'); } diff --git a/cspell.json b/cspell.json index b5e1476b..4531447e 100644 --- a/cspell.json +++ b/cspell.json @@ -1,49 +1,52 @@ { - "dictionaries": ["fr-fr", "en-gb"], + "dictionaries": [ + "en-gb", + "fr-fr" + ], "userWords": [ - "lightningcss", + "codesniffer", + "curryfication", + "eilandert", + "ERRMODE", + "gcch", + "giftcard", "haikuatelier", "healthcheck", - "traefik", "innodb", "jaegertracing", - "eilandert", - "valkey", - "somaxconn", - "woocommerce", - "Squiz", - "twentytwentyfour", - "symfony", - "phpstan", - "codesniffer", - "muplugin", - "wpautop", - "ERRMODE", "laravel", - "multishipping", + "lightningcss", "multiformats", - "curryfication", - "giftcard", - "taplo", + "multishipping", + "muplugin", "phpactor", - "gcch" + "phpstan", + "somaxconn", + "Squiz", + "symfony", + "taplo", + "traefik", + "twentytwentyfour", + "valkey", + "woocommerce", + "wpautop" ], "words": [ - "GLITCHTIP", - "Vali", + "classlike", + "Crell", + "Eles", "fdir", + "friendsofphp", + "GLITCHTIP", + "htmlburger", + "logtape", "mobily", "oxlint", - "valibot", - "zstandard", - "Eles", - "logtape", - "wpackagist", "phpdotenv", - "friendsofphp", - "htmlburger", - "Crell", + "Vali", + "valibot", + "wpackagist", "wpdb", - "classlike" + "zstandard" ] } diff --git a/justfile b/justfile index d420707c..ca7b666c 100755 --- a/justfile +++ b/justfile @@ -105,6 +105,12 @@ lint-js: --config cfg/oxlint.config.ts \ --format stylish +fix-js: + bun --bun oxlint \ + --config cfg/oxlint.config.ts \ + --format stylish \ + --fix --fix-suggestions --fix-dangerously + # Vérifie le code Sass avec Stylelint. [group('css')] [group('qualité')] diff --git a/lib/openapi3_1.json b/lib/openapi3_1.json index 7fc1a6b0..11f08a0d 100755 --- a/lib/openapi3_1.json +++ b/lib/openapi3_1.json @@ -3,7 +3,12 @@ "schemas": { "Count Low in Stock Items": { "$schema": "http:/json-schema.org/draft-04/schema#", - "properties": { "properties": { "total": "integer" }, "type": "object" }, + "properties": { + "properties": { + "total": "integer" + }, + "type": "object" + }, "title": "Count Low in Stock Items", "type": "object" }, @@ -12,7 +17,14 @@ "properties": { "properties": { "job_id": "integer", - "status": { "enum": ["pending", "complete", "failed"], "type": "string" } + "status": { + "enum": [ + "complete", + "failed", + "pending" + ], + "type": "string" + } }, "type": "object" }, @@ -25,18 +37,40 @@ "properties": { "activate": { "properties": { - "activated": { "items": { "type": "string" }, "type": "array" }, - "active": { "items": { "type": "string" }, "type": "array" }, + "activated": { + "items": { + "type": "string" + }, + "type": "array" + }, + "active": { + "items": { + "type": "string" + }, + "type": "array" + }, "errors": { "properties": { "error_data": { - "items": { "type": "string" }, - "patternProperties": { "^.*$": { "type": "string" } }, + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, "type": "object" }, "errors": { - "items": { "type": "string" }, - "patternProperties": { "^.*$": { "type": "string" } }, + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, "type": "object" } }, @@ -50,20 +84,42 @@ "errors": { "properties": { "error_data": { - "items": { "type": "string" }, - "patternProperties": { "^.*$": { "type": "string" } }, + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, "type": "object" }, "errors": { - "items": { "type": "string" }, - "patternProperties": { "^.*$": { "type": "string" } }, + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, "type": "object" } }, "type": "object" }, - "installed": { "items": { "type": "string" }, "type": "array" }, - "results": { "items": { "type": "string" }, "type": "array" } + "installed": { + "items": { + "type": "string" + }, + "type": "array" + }, + "results": { + "items": { + "type": "string" + }, + "type": "array" + } }, "type": "object" } @@ -119,34 +175,57 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "app_id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "format": "uuid", "type": "string" }, "created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The GMT date the application password was created.", "format": "date-time", "readonly": true, "type": "string" }, "last_ip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The IP address the application password was last used by.", "format": "ip", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "last_used": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The GMT date the application password was last used.", "format": "date-time", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The name of the application password.", "minLength": 1, "pattern": ".*\\S.*", @@ -154,13 +233,19 @@ "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "The generated password. Only available after adding an application.", "readonly": true, "type": "string" }, "uuid": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The unique identifier for the application password.", "format": "uuid", "readonly": true, @@ -176,38 +261,72 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}", "rel": "https:/api.w.org/action-assign-author", - "targetSchema": { "properties": { "author": { "type": "integer" } }, "type": "object" }, + "targetSchema": { + "properties": { + "author": { + "type": "integer" + } + }, + "type": "object" + }, "title": "The current user can change the author on this post." } ], "properties": { "alt_text": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the post.", "type": "integer" }, "caption": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The attachment caption.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Caption for the attachment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML caption for the attachment, transformed for display.", "readonly": true, "type": "string" @@ -216,41 +335,73 @@ "type": "object" }, "class_list": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of the class names for the post container element.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "comment_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attachment description.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Description for the attachment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description for the attachment, transformed for display.", "readonly": true, "type": "string" @@ -259,28 +410,42 @@ "type": "object" }, "featured_media": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the featured media for the post.", "type": "integer" }, "generated_slug": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Slug automatically generated from the post title.", "readonly": true, "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -290,124 +455,200 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "media_details": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Details about the media file, specific to its type.", "readonly": true, "type": "object" }, "media_type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Attachment type.", - "enum": ["image", "file"], + "enum": [ + "file", + "image" + ], "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "mime_type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The attachment MIME type.", "readonly": true, "type": "string" }, "missing_image_sizes": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "List of the missing image sizes of the attachment.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "permalink_template": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Permalink template for the post.", "readonly": true, "type": "string" }, "ping_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "post": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "source_url": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the original attachment file.", "format": "uri", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -416,7 +657,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -429,21 +674,36 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "create": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of created resources.", - "items": { "type": "object" }, + "items": { + "type": "object" + }, "type": "array" }, "delete": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of deleted resources.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "update": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of updated resources.", - "items": { "type": "object" }, + "items": { + "type": "object" + }, "type": "array" } }, @@ -454,52 +714,95 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "active_installs": { - "context": ["view"], + "context": [ + "view" + ], "description": "The number of sites that have activated this block.", "type": "integer" }, "author": { - "context": ["view"], + "context": [ + "view" + ], "description": "The WordPress.org username of the block author.", "type": "string" }, "author_block_count": { - "context": ["view"], + "context": [ + "view" + ], "description": "The number of blocks published by the same author.", "type": "integer" }, "author_block_rating": { - "context": ["view"], + "context": [ + "view" + ], "description": "The average rating of blocks published by the same author.", "type": "number" }, "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "A short description of the block, in human readable format.", "type": "string" }, "humanized_updated": { - "context": ["view"], + "context": [ + "view" + ], "description": "The date when the block was last updated, in fuzzy human readable format.", "type": "string" }, - "icon": { "context": ["view"], "description": "The block icon.", "format": "uri", "type": "string" }, - "id": { "context": ["view"], "description": "The block slug.", "type": "string" }, + "icon": { + "context": [ + "view" + ], + "description": "The block icon.", + "format": "uri", + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "The block slug.", + "type": "string" + }, "last_updated": { - "context": ["view"], + "context": [ + "view" + ], "description": "The date when the block was last updated.", "format": "date-time", "type": "string" }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "The block name, in namespace/block-name format.", "type": "string" }, - "rating": { "context": ["view"], "description": "The star rating of the block.", "type": "number" }, - "rating_count": { "context": ["view"], "description": "The number of ratings.", "type": "integer" }, + "rating": { + "context": [ + "view" + ], + "description": "The star rating of the block.", + "type": "number" + }, + "rating_count": { + "context": [ + "view" + ], + "description": "The number of ratings.", + "type": "integer" + }, "title": { - "context": ["view"], + "context": [ + "view" + ], "description": "The block title, in human readable format.", "type": "string" } @@ -511,81 +814,129 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "block_types": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Block types that the pattern is intended to be used with.", "readonly": true, "type": "array" }, "categories": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern's category slugs.", "readonly": true, "type": "array" }, "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern content.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern detailed description.", "readonly": true, "type": "string" }, "inserter": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Determines whether the pattern is visible in inserter.", "readonly": true, "type": "boolean" }, "keywords": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern keywords.", "readonly": true, "type": "array" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern name.", "readonly": true, "type": "string" }, "post_types": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An array of post types that the pattern is restricted to be used with.", "readonly": true, "type": "array" }, "source": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Where the pattern comes from e.g. core", "enum": [ "core", - "plugin", - "theme", "pattern-directory/core", + "pattern-directory/featured", "pattern-directory/theme", - "pattern-directory/featured" + "plugin", + "theme" ], "readonly": true, "type": "string" }, "template_types": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An array of template types where the pattern fits.", "readonly": true, "type": "array" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern title, in human readable format.", "readonly": true, "type": "string" }, "viewport_width": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern viewport width for inserter preview.", "readonly": true, "type": "number" @@ -598,19 +949,31 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The category description in a human-readable format.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The category label, in human readable format.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The category name.", "readonly": true, "type": "string" @@ -623,44 +986,86 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "allowed_blocks": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Allowed child block types.", - "items": { "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", "type": "string" }, + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "ancestor": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Ancestor blocks.", - "items": { "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", "type": "string" }, + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "api_version": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": 1, "description": "Version of block API.", "readonly": true, "type": "integer" }, "attributes": { - "additionalProperties": { "type": "object" }, - "context": ["embed", "view", "edit"], + "additionalProperties": { + "type": "object" + }, + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block attributes.", "properties": [], "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "block_hooks": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "This block is automatically inserted near any occurrence of the block types used as keys of this map, into a relative position given by the corresponding value.", "patternProperties": { "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$": { - "enum": ["before", "after", "first_child", "last_child"], + "enum": [ + "after", + "before", + "first_child", + "last_child" + ], "type": "string" } }, @@ -668,60 +1073,111 @@ "type": "object" }, "category": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block category.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Description of block type.", "readonly": true, "type": "string" }, "editor_script": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Editor script handle. DEPRECATED: Use `editor_script_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "editor_script_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Editor script handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "editor_style": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Editor style handle. DEPRECATED: Use `editor_style_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "editor_style_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Editor style handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "example": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block example.", "properties": { - "attributes": { "description": "The attributes used in the example.", "type": "object" }, + "attributes": { + "description": "The attributes used in the example.", + "type": "object" + }, "innerBlocks": { "description": "The list of inner blocks used in the example.", "items": { "properties": { - "attributes": { "description": "The attributes of the inner block.", "type": "object" }, + "attributes": { + "description": "The attributes of the inner block.", + "type": "object" + }, "innerBlocks": { "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", "type": "array" @@ -739,32 +1195,56 @@ } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "icon": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Icon of block type.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "is_dynamic": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": false, "description": "Is the block dynamically rendered.", "readonly": true, "type": "boolean" }, "keywords": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Block keywords.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique name identifying the block type.", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", "readonly": true, @@ -772,16 +1252,32 @@ "type": "string" }, "parent": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Parent blocks.", - "items": { "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", "type": "string" }, + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "provides_context": { - "additionalProperties": { "type": "string" }, - "context": ["embed", "view", "edit"], + "additionalProperties": { + "type": "string" + }, + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Context provided by blocks of this type.", "properties": [], @@ -789,22 +1285,41 @@ "type": "object" }, "script": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "script_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public facing and editor script handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "selectors": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Custom CSS selectors.", "properties": [], @@ -812,22 +1327,41 @@ "type": "object" }, "style": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "style_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public facing and editor style handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "styles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Block style variations.", "items": { @@ -836,9 +1370,19 @@ "description": "Inline CSS code that registers the CSS class required for the style.", "type": "string" }, - "label": { "description": "The human-readable label for the style.", "type": "string" }, - "name": { "description": "Unique name identifying the style.", "required": true, "type": "string" }, - "style_handle": { "description": "Contains the handle that defines the block style.", "type": "string" } + "label": { + "description": "The human-readable label for the style.", + "type": "string" + }, + "name": { + "description": "Unique name identifying the style.", + "required": true, + "type": "string" + }, + "style_handle": { + "description": "Contains the handle that defines the block style.", + "type": "string" + } }, "type": "object" }, @@ -846,7 +1390,11 @@ "type": "array" }, "supports": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Block supports.", "properties": [], @@ -854,40 +1402,71 @@ "type": "object" }, "textdomain": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Public text domain.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Title of block type.", "readonly": true, "type": "string" }, "uses_context": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Context values inherited by blocks of this type.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "variations": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block variations.", "items": { "properties": { - "attributes": { "description": "The initial values for attributes.", "type": "object" }, + "attributes": { + "description": "The initial values for attributes.", + "type": "object" + }, "category": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block category.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "description": { "description": "A detailed variation description.", @@ -895,16 +1474,26 @@ "type": "string" }, "example": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block example.", "properties": { - "attributes": { "description": "The attributes used in the example.", "type": "object" }, + "attributes": { + "description": "The attributes used in the example.", + "type": "object" + }, "innerBlocks": { "description": "The list of inner blocks used in the example.", "items": { "properties": { - "attributes": { "description": "The attributes of the inner block.", "type": "object" }, + "attributes": { + "description": "The attributes of the inner block.", + "type": "object" + }, "innerBlocks": { "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", "type": "array" @@ -922,20 +1511,33 @@ } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "icon": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Icon of block type.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "innerBlocks": { "description": "The list of inner blocks used in the example.", "items": { "properties": { - "attributes": { "description": "The attributes of the inner block.", "type": "object" }, + "attributes": { + "description": "The attributes of the inner block.", + "type": "object" + }, "innerBlocks": { "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", "type": "array" @@ -958,22 +1560,46 @@ "type": "boolean" }, "keywords": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Block keywords.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, - "name": { "description": "The unique and machine-readable name.", "required": true, "type": "string" }, + "name": { + "description": "The unique and machine-readable name.", + "required": true, + "type": "string" + }, "scope": { "default": null, "description": "The list of scopes where the variation is applicable. When not provided, it assumes all available scopes.", - "items": { "enum": ["block", "inserter", "transform"], "type": "string" }, + "items": { + "enum": [ + "block", + "inserter", + "transform" + ], + "type": "string" + }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, - "title": { "description": "A human-readable variation title.", "required": true, "type": "string" } + "title": { + "description": "A human-readable variation title.", + "required": true, + "type": "string" + } }, "type": "object" }, @@ -981,35 +1607,66 @@ "type": "array" }, "view_script": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Public facing script handle. DEPRECATED: Use `view_script_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "view_script_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public facing script handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "view_script_module_ids": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public-facing script module IDs.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "view_style_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public-facing style handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] } }, "title": "block-type", @@ -1019,81 +1676,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "billing_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current set billing address for the customer.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "readonly": true, "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "readonly": true, "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "readonly": true, "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "readonly": true, "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "readonly": true, "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "readonly": true, "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "readonly": true, "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "readonly": true, "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "readonly": true, "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "readonly": true, "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "readonly": true, "required": true, @@ -1104,76 +1797,115 @@ "type": "object" }, "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of applied basket coupons.", "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The coupon's unique code.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The discount type for the coupon (eg percentage or fixed amount)", "readonly": true, "type": "string" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount applied by this coupon.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount applied by this coupon.", "readonly": true, "type": "string" @@ -1189,47 +1921,71 @@ "type": "array" }, "cross_sells": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of cross-sells items related to basket items.", "items": { "properties": { "add_to_cart": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Add to basket button parameters.", "properties": { "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Button description.", "readonly": true, "type": "string" }, "maximum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The maximum quantity that can be added to the basket.", "readonly": true, "type": "integer" }, "minimum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The minimum quantity that can be added to the basket.", "readonly": true, "type": "integer" }, "multiple_of": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 1, "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", "readonly": true, "type": "integer" }, "text": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Button text.", "readonly": true, "type": "string" }, "url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Add to basket URL.", "readonly": true, "type": "string" @@ -1239,59 +1995,89 @@ "type": "object" }, "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of attributes (taxonomy terms) assigned to the product. For variable products, these are mapped to variations (see the `variations` field).", "items": { "properties": { "has_variations": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if this attribute is used by product variations.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute name.", "readonly": true, "type": "string" }, "taxonomy": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute taxonomy, or null if the attribute is not taxonomy based.", "readonly": true, "type": "string" }, "terms": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of assigned attribute terms.", "items": { "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If this is a default attribute", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The term ID, or 0 if the attribute is not a global attribute.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The term name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The term slug.", "readonly": true, "type": "string" @@ -1309,36 +2095,54 @@ "type": "array" }, "average_rating": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reviews average rating.", "readonly": true, "type": "string" }, "categories": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of categories, if applicable.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID", "readonly": true, "type": "number" }, "link": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category link", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug", "readonly": true, "type": "string" @@ -1350,68 +2154,109 @@ "type": "array" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product full description in HTML format.", "readonly": true, "type": "string" }, - "extensions": { "context": ["view", "edit"], "properties": [], "readonly": true, "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, "has_options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Does the product have additional options before it can be added to the basket?", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "images": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of images.", "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "readonly": true, "type": "string" }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "readonly": true, "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "readonly": true, "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "readonly": true, "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "readonly": true, @@ -1424,140 +2269,215 @@ "type": "array" }, "is_in_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the product in stock?", "readonly": true, "type": "boolean" }, "is_on_backorder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the product stock backordered? This will also return false if backorder notifications are turned off.", "readonly": true, "type": "boolean" }, "is_purchasable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the product purchasable?", "readonly": true, "type": "boolean" }, "low_stock_remaining": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity left in stock if stock is low, or null if not applicable.", "readonly": true, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, "type": "string" }, "on_sale": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the product on sale?", "readonly": true, "type": "boolean" }, "parent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ID of the parent product, if applicable.", "readonly": true, "type": "integer" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product URL.", "format": "uri", "readonly": true, "type": "string" }, "price_html": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price string formatted as HTML.", "readonly": true, "type": "string" }, "prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price data provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price range, if applicable.", "properties": { "max_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" }, "min_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" @@ -1567,60 +2487,90 @@ "type": "object" }, "review_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of reviews that the product has.", "readonly": true, "type": "integer" }, "short_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product short description in HTML format.", "readonly": true, "type": "string" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product slug.", "readonly": true, "type": "string" }, "sold_individually": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If true, only one item of this product is allowed for purchase in a single order.", "readonly": true, "type": "boolean" }, "tags": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of tags, if applicable.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID", "readonly": true, "type": "number" }, "link": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag link", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug", "readonly": true, "type": "string" @@ -1632,35 +2582,53 @@ "type": "array" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product type.", "readonly": true, "type": "string" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product variation attributes, if applicable.", "readonly": true, "type": "string" }, "variations": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of variation IDs, if applicable.", "items": { "properties": { "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of variation attributes.", "items": { "properties": { "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute name.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The assigned attribute.", "readonly": true, "type": "string" @@ -1672,7 +2640,10 @@ "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", "readonly": true, "type": "integer" @@ -1690,18 +2661,27 @@ "type": "array" }, "errors": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket item errors, for example, items in the basket which are out of stock.", "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Error code", "readonly": true, "type": "string" }, "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Error message", "readonly": true, "type": "string" @@ -1712,73 +2692,124 @@ "readonly": true, "type": "array" }, - "extensions": { "context": ["view", "edit"], "properties": [], "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "type": "object" + }, "fees": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket fees.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the fee within the basket.", "readonly": true, "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Fee name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "readonly": true, + "type": "string" + }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amount for this fee.", "readonly": true, "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax amount for this fee.", "readonly": true, "type": "string" @@ -1794,85 +2825,137 @@ "type": "array" }, "has_calculated_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket meets the criteria for showing shipping costs, and rates have been calculated and included in the totals.", "readonly": true, "type": "boolean" }, "items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket items.", "items": { "properties": { "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if backorders are allowed past stock availability.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "catalog_visibility": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether the product is visible in the catalogue", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product full description in HTML format.", "readonly": true, "type": "string" }, - "extensions": { "context": ["view", "edit"], "properties": [], "readonly": true, "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item product or variation ID.", "readonly": true, "type": "integer" }, "images": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of images.", "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "readonly": true, "type": "string" }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "readonly": true, "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "readonly": true, "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "readonly": true, "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "readonly": true, @@ -1885,24 +2968,36 @@ "type": "array" }, "item_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Metadata related to the item", "items": { "properties": { "display": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Optionally, how the metadata value should be displayed to the user.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the metadata.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Value of the metadata.", "readonly": true, "type": "string" @@ -1914,142 +3009,220 @@ "type": "array" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the item.", "readonly": true, "type": "string" }, "low_stock_remaining": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity left in stock if stock is low, or null if not applicable.", "readonly": true, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, "type": "string" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product URL.", "format": "uri", "readonly": true, "type": "string" }, "prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price data for the product in the current line item, including or excluding taxes based on the \"display prices during basket and checkout\" setting. Provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price range, if applicable.", "properties": { "max_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" }, "min_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "raw_prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", "properties": { "precision": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal precision of the returned prices.", "readonly": true, "type": "integer" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" @@ -2059,36 +3232,54 @@ "type": "object" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of this item.", "readonly": true, "type": "number" }, "quantity_limits": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How the quantity of this item should be controlled, for example, any limits in place.", "properties": { "editable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "If the quantity is editable or fixed.", "readonly": true, "type": "boolean" }, "maximum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The maximum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "minimum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The minimum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "multiple_of": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 1, "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", "readonly": true, @@ -2099,95 +3290,145 @@ "type": "object" }, "short_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product short description in HTML format.", "readonly": true, "type": "string" }, "show_backorder_badge": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the product is on backorder.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock keeping unit, if applicable.", "readonly": true, "type": "string" }, "sold_individually": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If true, only one item of this product is allowed for purchase in a single order.", "readonly": true, "type": "boolean" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "line_subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (the price of the product before coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax.", "readonly": true, "type": "string" }, "line_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (the price of the product after coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax.", "readonly": true, "type": "string" @@ -2197,24 +3438,36 @@ "type": "object" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item type.", "readonly": true, "type": "string" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Chosen attributes (for variations).", "items": { "properties": { "attribute": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute name.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute value.", "readonly": true, "type": "string" @@ -2232,110 +3485,161 @@ "type": "array" }, "items_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of items in the basket.", "readonly": true, "type": "integer" }, "items_weight": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total weight (in grams) of all products in the basket.", "readonly": true, "type": "number" }, "needs_payment": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.", "readonly": true, "type": "boolean" }, "needs_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.", "readonly": true, "type": "boolean" }, "payment_methods": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available payment method IDs that can be used to process the order.", "readonly": true, "type": "array" }, "payment_requirements": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of required payment gateway features to process the order.", "readonly": true, "type": "array" }, "shipping_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current set shipping address for the customer.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "readonly": true, "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "readonly": true, "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "readonly": true, "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "readonly": true, "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "readonly": true, "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "readonly": true, "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "readonly": true, "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "readonly": true, "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "readonly": true, "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "readonly": true, "required": true, @@ -2346,46 +3650,70 @@ "type": "object" }, "shipping_rates": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available shipping rates for the basket.", "items": { "properties": { "destination": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping destination address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First line of the address being shipped to.", "readonly": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Second line of the address being shipped to.", "readonly": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City of the address being shipped to.", "readonly": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code for the country of the address being shipped to.", "readonly": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Zip or Postcode of the address being shipped to.", "readonly": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code, or name, for the state, province, or district of the address being shipped to.", "readonly": true, "type": "string" @@ -2395,24 +3723,36 @@ "type": "object" }, "items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket items the returned shipping rates apply to.", "items": { "properties": { "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the item within the basket.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the item.", "readonly": true, "type": "string" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of the item in the current package.", "readonly": true, "type": "number" @@ -2424,95 +3764,146 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the package.", "readonly": true, "type": "string" }, "package_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID of the package the shipping rates belong to.", "readonly": true, - "type": ["integer", "string"] + "type": [ + "integer", + "string" + ] }, "shipping_rates": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of shipping rates.", "items": { "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "delivery_time": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Delivery time estimate text, e.g. 3-5 business days.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Description of the shipping rate, e.g. Dispatched via Royal Mail.", "readonly": true, "type": "string" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Instance ID of the shipping method that provided the rate.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data attached to the shipping rate.", "items": { "properties": { "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", "readonly": true, "type": "string" @@ -2524,37 +3915,55 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ID of the shipping method that provided the rate.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the shipping rate, e.g. Express shipping.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price of this shipping rate using the smallest unit of the currency.", "readonly": true, "type": "string" }, "rate_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ID of the shipping rate.", "readonly": true, "type": "string" }, "selected": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if this is the rate currently selected by the customer for the basket.", "readonly": true, "type": "boolean" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxes applied to this shipping rate using the smallest unit of the currency.", "readonly": true, "type": "string" @@ -2572,70 +3981,106 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Basket total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "tax_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Lines of taxes applied to items and shipping.", "items": { "properties": { "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The name of the tax.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The amount of tax charged.", "readonly": true, "type": "string" }, "rate": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The rate at which tax is applied.", "readonly": true, "type": "string" @@ -2647,61 +4092,97 @@ "type": "array" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount from applied coupons.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount from applied coupons.", "readonly": true, "type": "string" }, "total_fees": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of any applied fees.", "readonly": true, "type": "string" }, "total_fees_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on fees.", "readonly": true, "type": "string" }, "total_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of items in the basket.", "readonly": true, "type": "string" }, "total_items_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on items in the basket.", "readonly": true, "type": "string" }, "total_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price the customer will pay.", "readonly": true, "type": "string" }, "total_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of shipping. If shipping has not been calculated, a null response will be sent.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "total_shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax applied to items and shipping.", "readonly": true, "type": "string" @@ -2723,66 +4204,106 @@ "cart_coupon": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "code": { "context": ["view", "edit"], "description": "The coupon's unique code.", "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "The coupon's unique code.", + "type": "string" + }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The discount type for the coupon (eg percentage or fixed amount)", "type": "string" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount applied by this coupon.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount applied by this coupon.", "readonly": true, "type": "string" @@ -2799,56 +4320,113 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if backorders are allowed past stock availability.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "catalog_visibility": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether the product is visible in the catalogue", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product full description in HTML format.", "readonly": true, "type": "string" }, - "extensions": { "context": ["view", "edit"], "properties": [], "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "type": "object" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item product or variation ID.", "readonly": true, "type": "integer" }, "images": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of images.", "items": { "properties": { - "alt": { "context": ["view", "edit"], "description": "Image alternative text.", "type": "string" }, - "id": { "context": ["view", "edit"], "description": "Image ID.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Image name.", "type": "string" }, + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "type": "string" @@ -2860,24 +4438,36 @@ "type": "array" }, "item_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Metadata related to the item", "items": { "properties": { "display": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Optionally, how the metadata value should be displayed to the user.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the metadata.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Value of the metadata.", "readonly": true, "type": "string" @@ -2889,137 +4479,220 @@ "type": "array" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the item.", "readonly": true, "type": "string" }, "low_stock_remaining": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity left in stock if stock is low, or null if not applicable.", "readonly": true, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "readonly": true, "type": "string" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product URL.", "format": "uri", "readonly": true, "type": "string" }, "prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price data for the product in the current line item, including or excluding taxes based on the \"display prices during basket and checkout\" setting. Provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price range, if applicable.", "properties": { "max_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" }, "min_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "raw_prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", "properties": { "precision": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal precision of the returned prices.", "readonly": true, "type": "integer" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" @@ -3029,36 +4702,54 @@ "type": "object" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of this item.", "readonly": true, "type": "number" }, "quantity_limits": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How the quantity of this item should be controlled, for example, any limits in place.", "properties": { "editable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "If the quantity is editable or fixed.", "readonly": true, "type": "boolean" }, "maximum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The maximum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "minimum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The minimum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "multiple_of": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 1, "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", "readonly": true, @@ -3069,95 +4760,145 @@ "type": "object" }, "short_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product short description in HTML format.", "readonly": true, "type": "string" }, "show_backorder_badge": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the product is on backorder.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock keeping unit, if applicable.", "readonly": true, "type": "string" }, "sold_individually": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If true, only one item of this product is allowed for purchase in a single order.", "readonly": true, "type": "boolean" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "line_subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (the price of the product before coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax.", "readonly": true, "type": "string" }, "line_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (the price of the product after coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax.", "readonly": true, "type": "string" @@ -3166,20 +4907,37 @@ "readonly": true, "type": "object" }, - "type": { "context": ["view", "edit"], "description": "The item type.", "readonly": true, "type": "string" }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The item type.", + "readonly": true, + "type": "string" + }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Chosen attributes (for variations).", "items": { "properties": { "attribute": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute name.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute value.", "readonly": true, "type": "string" @@ -3198,46 +4956,89 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, - "parent": { "context": ["view", "edit"], "description": "The parent term ID.", "type": "integer" }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The parent term ID.", + "type": "integer" + }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["category"], + "enum": [ + "category" + ], "readonly": true, "type": "string" } @@ -3249,58 +5050,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "additional_fields": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional fields to be persisted on the order.", "properties": [], "required": false, "type": "object" }, "billing_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City", "required": true, "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company", "required": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "required": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, - "email": { "context": ["view", "edit"], "description": "Email", "required": true, "type": "string" }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone", "required": true, "type": "string" }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -3310,146 +5170,238 @@ "type": "object" }, "create_account": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether to create a new user account as part of order processing.", "type": "boolean" }, "customer_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Customer ID if registered. Will return 0 for guests.", "readonly": true, "type": "integer" }, "customer_note": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Note added to the order by the customer during checkout.", "type": "string" }, "extensions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "properties": { "woocommerce/order-attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] } }, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] } }, "type": "object" }, "order_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The order ID to process during checkout.", "readonly": true, "type": "integer" }, "order_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order key used to check validity or protect access to certain order data.", "readonly": true, "type": "string" }, "order_number": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order number used for display.", "readonly": true, "type": "string" }, "payment_method": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID of the payment method being used to process the payment.", - "enum": ["bacs", "cheque", "cod"], + "enum": [ + "bacs", + "cheque", + "cod" + ], "type": "string" }, "payment_result": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Result of payment processing, or false if not yet processed.", "properties": { "payment_details": { "description": "An array of data being returned from the payment gateway.", "items": { - "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, "type": "object" }, "readonly": true, @@ -3470,50 +5422,98 @@ "type": "object" }, "shipping_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City", "required": true, "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company", "required": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "required": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone", "required": true, "type": "string" }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -3522,7 +5522,10 @@ "type": "object" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order status. Payment providers will update this value after payment.", "readonly": true, "type": "string" @@ -3535,58 +5538,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "additional_fields": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional fields to be persisted on the order.", "properties": [], "required": false, "type": "object" }, "billing_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City", "required": true, "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company", "required": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "required": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, - "email": { "context": ["view", "edit"], "description": "Email", "required": true, "type": "string" }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone", "required": true, "type": "string" }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -3596,141 +5658,230 @@ "type": "object" }, "customer_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Customer ID if registered. Will return 0 for guests.", "readonly": true, "type": "integer" }, "customer_note": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Note added to the order by the customer during checkout.", "type": "string" }, "extensions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "properties": { "woocommerce/order-attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] } }, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] } }, "type": "object" }, "order_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The order ID to process during checkout.", "readonly": true, "type": "integer" }, "order_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order key used to check validity or protect access to certain order data.", "readonly": true, "type": "string" }, "order_number": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order number used for display.", "readonly": true, "type": "string" }, "payment_method": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID of the payment method being used to process the payment.", - "enum": ["bacs", "cheque", "cod"], + "enum": [ + "bacs", + "cheque", + "cod" + ], "type": "string" }, "payment_result": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Result of payment processing, or false if not yet processed.", "properties": { "payment_details": { "description": "An array of data being returned from the payment gateway.", "items": { - "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, "type": "object" }, "readonly": true, @@ -3751,50 +5902,98 @@ "type": "object" }, "shipping_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City", "required": true, "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company", "required": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "required": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone", "required": true, "type": "string" }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -3803,7 +6002,10 @@ "type": "object" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order status. Payment providers will update this value after payment.", "readonly": true, "type": "string" @@ -3816,28 +6018,48 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the user object, if author was a user.", "type": "integer" }, "author_avatar_urls": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URLs for the comment author.", "properties": { "24": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 24 pixels.", "format": "uri", "type": "string" }, "48": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 48 pixels.", "format": "uri", "type": "string" }, "96": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 96 pixels.", "format": "uri", "type": "string" @@ -3847,44 +6069,68 @@ "type": "object" }, "author_email": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Email address for the comment author.", "format": "email", "type": "string" }, "author_ip": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "IP address for the comment author.", "format": "ip", "type": "string" }, "author_name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Display name for the comment author.", "type": "string" }, "author_url": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL for the comment author.", "format": "uri", "type": "string" }, "author_user_agent": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "User agent for the comment author.", "type": "string" }, "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The content for the comment.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the comment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the comment, transformed for display.", "readonly": true, "type": "string" @@ -3893,46 +6139,87 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the comment was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the comment was published, as GMT.", "format": "date-time", "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the comment.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the comment.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 0, "description": "The ID for the parent of the comment.", "type": "integer" }, "post": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 0, "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "context": ["view", "edit"], "description": "State of the comment.", "type": "string" }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "State of the comment.", + "type": "string" + }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of the comment.", "readonly": true, "type": "string" @@ -3945,32 +6232,107 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "avatar_url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Avatar URL.", "readonly": true, "type": "string" }, "billing": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of billing address data.", "properties": { - "address_1": { "context": ["view", "edit"], "description": "Address line 1", "type": "string" }, - "address_2": { "context": ["view", "edit"], "description": "Address line 2", "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company name.", "type": "string" }, - "country": { "context": ["view", "edit"], "description": "ISO code of the country.", "type": "string" }, + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "ISO code of the country.", + "type": "string" + }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "First name.", "type": "string" }, - "last_name": { "context": ["view", "edit"], "description": "Last name.", "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone number.", "type": "string" }, - "postcode": { "context": ["view", "edit"], "description": "Postal code.", "type": "string" }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name.", + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name.", + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone number.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" + }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -3978,84 +6340,223 @@ "type": "object" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the customer was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the customer was created, as GMT.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the customer was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the customer was last modified, as GMT.", "readonly": true, "type": "date-time" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The email address for the customer.", "format": "email", "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "Customer first name.", "type": "string" }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "Customer first name.", + "type": "string" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "is_paying_customer": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the customer a paying customer?", "readonly": true, "type": "bool" }, - "last_name": { "context": ["view", "edit"], "description": "Customer last name.", "type": "string" }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Customer last name.", + "type": "string" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of orders made by the customer.", "readonly": true, "type": "integer" }, - "password": { "context": ["edit"], "description": "Customer password.", "type": "string" }, - "role": { "context": ["view", "edit"], "description": "Customer role.", "readonly": true, "type": "string" }, + "password": { + "context": [ + "edit" + ], + "description": "Customer password.", + "type": "string" + }, + "role": { + "context": [ + "edit", + "view" + ], + "description": "Customer role.", + "readonly": true, + "type": "string" + }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of shipping address data.", "properties": { - "address_1": { "context": ["view", "edit"], "description": "Address line 1", "type": "string" }, - "address_2": { "context": ["view", "edit"], "description": "Address line 2", "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company name.", "type": "string" }, - "country": { "context": ["view", "edit"], "description": "ISO code of the country.", "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "First name.", "type": "string" }, - "last_name": { "context": ["view", "edit"], "description": "Last name.", "type": "string" }, - "postcode": { "context": ["view", "edit"], "description": "Postal code.", "type": "string" }, + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "ISO code of the country.", + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name.", + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" + }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -4063,12 +6564,22 @@ "type": "object" }, "total_spent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amount spent.", "readonly": true, "type": "string" }, - "username": { "context": ["view", "edit"], "description": "Customer login name.", "type": "string" } + "username": { + "context": [ + "edit", + "view" + ], + "description": "Customer login name.", + "type": "string" + } }, "title": "customer", "type": "object" @@ -4077,55 +6588,111 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "access_expires": { - "context": ["view"], + "context": [ + "view" + ], "description": "The date when download access expires, in the site's timezone.", "readonly": true, "type": "string" }, "access_expires_gmt": { - "context": ["view"], + "context": [ + "view" + ], "description": "The date when download access expires, as GMT.", "readonly": true, "type": "string" }, - "download_id": { "context": ["view"], "description": "Download ID.", "readonly": true, "type": "string" }, + "download_id": { + "context": [ + "view" + ], + "description": "Download ID.", + "readonly": true, + "type": "string" + }, "download_name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Downloadable file name.", "readonly": true, "type": "string" }, "download_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Download file URL.", "readonly": true, "type": "string" }, "downloads_remaining": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of downloads remaining.", "readonly": true, "type": "string" }, "file": { - "context": ["view"], + "context": [ + "view" + ], "description": "File details.", "properties": { - "file": { "context": ["view"], "description": "File URL.", "readonly": true, "type": "string" }, - "name": { "context": ["view"], "description": "File name.", "readonly": true, "type": "string" } + "file": { + "context": [ + "view" + ], + "description": "File URL.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "File name.", + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" }, - "order_id": { "context": ["view"], "description": "Order ID.", "readonly": true, "type": "integer" }, - "order_key": { "context": ["view"], "description": "Order key.", "readonly": true, "type": "string" }, + "order_id": { + "context": [ + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, + "order_key": { + "context": [ + "view" + ], + "description": "Order key.", + "readonly": true, + "type": "string" + }, "product_id": { - "context": ["view"], + "context": [ + "view" + ], "description": "Downloadable product ID.", "readonly": true, "type": "integer" }, - "product_name": { "context": ["view"], "description": "Product name.", "readonly": true, "type": "string" } + "product_name": { + "context": [ + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + } }, "title": "customer_download", "type": "object" @@ -4134,68 +6701,101 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "code": { - "context": ["view"], + "context": [ + "view" + ], "description": "2 character continent code.", "readonly": true, "type": "string" }, "countries": { - "context": ["view"], + "context": [ + "view" + ], "description": "List of countries on this continent.", "items": { - "context": ["view"], + "context": [ + "view" + ], "properties": { "code": { - "context": ["view"], + "context": [ + "view" + ], "description": "ISO3166 alpha-2 country code.", "readonly": true, "type": "string" }, "currency_code": { - "context": ["view"], + "context": [ + "view" + ], "description": "Default ISO4127 alpha-3 currency code for the country.", "readonly": true, "type": "string" }, "currency_pos": { - "context": ["view"], + "context": [ + "view" + ], "description": "Currency symbol position for this country.", "readonly": true, "type": "string" }, "decimal_sep": { - "context": ["view"], + "context": [ + "view" + ], "description": "Decimal separator for displayed prices for this country.", "readonly": true, "type": "string" }, "dimension_unit": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unit lengths are defined in for this country.", "readonly": true, "type": "string" }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Full name of country.", "readonly": true, "type": "string" }, "num_decimals": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of decimal points shown in displayed prices for this country.", "readonly": true, "type": "integer" }, "states": { - "context": ["view"], + "context": [ + "view" + ], "description": "List of states in this country.", "items": { - "context": ["view"], + "context": [ + "view" + ], "properties": { - "code": { "context": ["view"], "description": "State code.", "readonly": true, "type": "string" }, + "code": { + "context": [ + "view" + ], + "description": "State code.", + "readonly": true, + "type": "string" + }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Full name of state.", "readonly": true, "type": "string" @@ -4208,13 +6808,17 @@ "type": "array" }, "thousand_sep": { - "context": ["view"], + "context": [ + "view" + ], "description": "Thousands separator for displayed prices in this country.", "readonly": true, "type": "string" }, "weight_unit": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unit weights are defined in for this country.", "readonly": true, "type": "string" @@ -4226,7 +6830,14 @@ "readonly": true, "type": "array" }, - "name": { "context": ["view"], "description": "Full name of continent.", "readonly": true, "type": "string" } + "name": { + "context": [ + "view" + ], + "description": "Full name of continent.", + "readonly": true, + "type": "string" + } }, "title": "data_continents", "type": "object" @@ -4235,21 +6846,43 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "code": { - "context": ["view"], + "context": [ + "view" + ], "description": "ISO3166 alpha-2 country code.", "readonly": true, "type": "string" }, - "name": { "context": ["view"], "description": "Full name of country.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Full name of country.", + "readonly": true, + "type": "string" + }, "states": { - "context": ["view"], + "context": [ + "view" + ], "description": "List of states in this country.", "items": { - "context": ["view"], + "context": [ + "view" + ], "properties": { - "code": { "context": ["view"], "description": "State code.", "readonly": true, "type": "string" }, + "code": { + "context": [ + "view" + ], + "description": "State code.", + "readonly": true, + "type": "string" + }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Full name of state.", "readonly": true, "type": "string" @@ -4268,9 +6901,30 @@ "data_currencies": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "code": { "context": ["view"], "description": "ISO4217 currency code.", "readonly": true, "type": "string" }, - "name": { "context": ["view"], "description": "Full name of currency.", "readonly": true, "type": "string" }, - "symbol": { "context": ["view"], "description": "Currency symbol.", "readonly": true, "type": "string" } + "code": { + "context": [ + "view" + ], + "description": "ISO4217 currency code.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of currency.", + "readonly": true, + "type": "string" + }, + "symbol": { + "context": [ + "view" + ], + "description": "Currency symbol.", + "readonly": true, + "type": "string" + } }, "title": "data_currencies", "type": "object" @@ -4278,7 +6932,14 @@ "data_download_ips": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "user_ip_address": { "context": ["view"], "description": "IP address.", "readonly": true, "type": "string" } + "user_ip_address": { + "context": [ + "view" + ], + "description": "IP address.", + "readonly": true, + "type": "string" + } }, "title": "data_download_ips", "type": "object" @@ -4287,12 +6948,21 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "Data resource description.", "readonly": true, "type": "string" }, - "slug": { "context": ["view"], "description": "Data resource ID.", "readonly": true, "type": "string" } + "slug": { + "context": [ + "view" + ], + "description": "Data resource ID.", + "readonly": true, + "type": "string" + } }, "title": "data_index", "type": "object" @@ -4301,27 +6971,47 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "categories": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The categories for the font collection.", "type": "array" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The description for the font collection.", "type": "string" }, "font_families": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The font families for the font collection.", "type": "array" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The name for the font collection.", "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the font collection.", "readonly": true, "type": "string" @@ -4334,12 +7024,17 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "headers": { - "context": ["view"], + "context": [ + "view" + ], "description": "Table headers.", "items": { "properties": { "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Table column header.", "readonly": true, "type": "string" @@ -4350,34 +7045,56 @@ "readonly": true, "type": "array" }, - "id": { "context": ["view"], "description": "Leaderboard ID.", "readonly": true, "type": "string" }, + "id": { + "context": [ + "view" + ], + "description": "Leaderboard ID.", + "readonly": true, + "type": "string" + }, "label": { - "context": ["view"], + "context": [ + "view" + ], "description": "Displayed title for the leaderboard.", "readonly": true, "type": "string" }, "rows": { - "context": ["view"], + "context": [ + "view" + ], "description": "Table rows.", "items": { "properties": { "display": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Table cell display.", "readonly": true, "type": "string" }, "format": { - "context": ["view"], + "context": [ + "view" + ], "description": "Table cell format.", - "enum": ["currency", "number"], + "enum": [ + "currency", + "number" + ], "readonly": true, "required": false, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Table cell value.", "readonly": true, "type": "string" @@ -4396,45 +7113,81 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "channel": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unique identifier for the marketing channel that this campaign belongs to.", "readonly": true, "type": "string" }, "cost": { - "context": ["view"], + "context": [ + "view" + ], "description": "Cost of the marketing campaign.", "properties": { - "currency": { "context": ["view"], "readonly": true, "type": "string" }, - "value": { "context": ["view"], "readonly": true, "type": "string" } + "currency": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" }, "id": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unique identifier for the marketing campaign.", "readonly": true, "type": "string" }, "manage_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "URL to the campaign management page.", "readonly": true, "type": "string" }, "sales": { - "context": ["view"], + "context": [ + "view" + ], "description": "Sales of the marketing campaign.", "properties": { - "currency": { "context": ["view"], "readonly": true, "type": "string" }, - "value": { "context": ["view"], "readonly": true, "type": "string" } + "currency": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" }, "title": { - "context": ["view"], + "context": [ + "view" + ], "description": "Title of the marketing campaign.", "readonly": true, "type": "string" @@ -4447,17 +7200,23 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "channel": { - "context": ["view"], + "context": [ + "view" + ], "description": "The marketing channel that this campaign type belongs to.", "properties": { "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "The name of the marketing channel that this campaign type belongs to.", "readonly": true, "type": "string" }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unique identifier of the marketing channel that this campaign type belongs to.", "readonly": true, "type": "string" @@ -4467,31 +7226,41 @@ "type": "object" }, "create_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "URL to the create campaign page for this campaign type.", "readonly": true, "type": "string" }, "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "Description of the marketing campaign type.", "readonly": true, "type": "string" }, "icon_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "URL to an image/icon for the campaign type.", "readonly": true, "type": "string" }, "id": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unique identifier for the marketing campaign type.", "readonly": true, "type": "string" }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Name of the marketing campaign type.", "readonly": true, "type": "string" @@ -4504,49 +7273,65 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "Description of the marketing channel.", "readonly": true, "type": "string" }, "errors_count": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).", "readonly": true, "type": "string" }, "icon": { - "context": ["view"], + "context": [ + "view" + ], "description": "Path to the channel icon.", "readonly": true, "type": "string" }, "is_setup_completed": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not the marketing channel is set up.", "readonly": true, "type": "boolean" }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Name of the marketing channel.", "readonly": true, "type": "string" }, "product_listings_status": { - "context": ["view"], + "context": [ + "view" + ], "description": "Status of the marketing channel's product listings.", "readonly": true, "type": "string" }, "settings_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "URL to the settings page, or the link to complete the setup/onboarding if the channel has not been set up yet.", "readonly": true, "type": "string" }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "Unique identifier string for the marketing channel extension, also known as the plugin slug.", "readonly": true, "type": "string" @@ -4558,19 +7343,74 @@ "marketing_recommendation": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "categories": { "context": ["view"], "items": { "type": "string" }, "readonly": true, "type": "array" }, - "description": { "context": ["view"], "readonly": true, "type": "string" }, - "direct_install": { "context": ["view"], "readonly": true, "type": "string" }, - "icon": { "context": ["view"], "readonly": true, "type": "string" }, - "plugin": { "context": ["view"], "readonly": true, "type": "string" }, - "product": { "context": ["view"], "readonly": true, "type": "string" }, - "subcategories": { - "context": ["view"], + "categories": { + "context": [ + "view" + ], "items": { - "context": ["view"], + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "description": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "direct_install": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "icon": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "plugin": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "product": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "subcategories": { + "context": [ + "view" + ], + "items": { + "context": [ + "view" + ], "properties": { - "name": { "context": ["view"], "readonly": true, "type": "string" }, - "slug": { "context": ["view"], "readonly": true, "type": "string" } + "name": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" @@ -4579,12 +7419,28 @@ "type": "array" }, "tags": { - "context": ["view"], + "context": [ + "view" + ], "items": { - "context": ["view"], + "context": [ + "view" + ], "properties": { - "name": { "context": ["view"], "readonly": true, "type": "string" }, - "slug": { "context": ["view"], "readonly": true, "type": "string" } + "name": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" @@ -4592,8 +7448,20 @@ "readonly": true, "type": "array" }, - "title": { "context": ["view"], "readonly": true, "type": "string" }, - "url": { "context": ["view"], "readonly": true, "type": "string" } + "title": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "title": "marketing_recommendation", "type": "object" @@ -4602,19 +7470,31 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The description of the menu location.", "readonly": true, "type": "string" }, "menu": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the assigned menu.", "readonly": true, "type": "integer" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The name of the menu location.", "readonly": true, "type": "string" @@ -4627,36 +7507,67 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "auto_add": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "locations": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The locations assigned to the menu.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } @@ -4671,7 +7582,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -4679,14 +7598,30 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/action-assign-menus", "targetSchema": { - "properties": { "menus": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "menus": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the nav_menu taxonomy." @@ -4695,7 +7630,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/action-create-menus", "targetSchema": { - "properties": { "menus": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "menus": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the nav_menu taxonomy." @@ -4703,29 +7645,54 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/menu-item-object", - "targetSchema": { "properties": { "object": { "type": "integer" } }, "type": "object" }, + "targetSchema": { + "properties": { + "object": { + "type": "integer" + } + }, + "type": "object" + }, "title": "Get linked object." } ], "properties": { "attr_title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, "classes": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Class names for the link element of this menu item.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The description of this menu item.", "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 0, "description": "Unique identifier for the object.", "minimum": 0, @@ -4733,111 +7700,189 @@ "type": "integer" }, "invalid": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the menu item represents an object that no longer exists .", "readonly": true, "type": "boolean" }, "menu_order": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 1, "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "minimum": 1, "type": "integer" }, "menus": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "object": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" }, "object_id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 0, "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "minimum": 0, "type": "integer" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 0, "description": "The ID for the parent of the object.", "minimum": 0, "type": "integer" }, "status": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": "publish", "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "target": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The target attribute of the link element for this menu item.", - "enum": ["_blank", ""], + "enum": [ + "", + "_blank" + ], "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the object.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["string", "object"] + "type": [ + "object", + "string" + ] }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": "custom", "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "enum": ["taxonomy", "post_type", "post_type_archive", "custom"], + "enum": [ + "custom", + "post_type", + "post_type_archive", + "taxonomy" + ], "type": "string" }, "type_label": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The singular label used to describe this type of menu item.", "readonly": true, "type": "string" }, "url": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The URL to which this menu item points.", "format": "uri", "type": "string" }, "xfn": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The XFN relationship expressed in the link of this menu item.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" } }, @@ -4848,79 +7893,134 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the revision, as it exists in the database.", "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the object.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["string", "object"] + "type": [ + "object", + "string" + ] } }, "title": "nav_menu_item-revision", @@ -4930,7 +8030,11 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The unique identifier for the Navigation Menu.", "readonly": true, "type": "integer" @@ -4943,109 +8047,170 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "actions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of actions, if any, for the note.", "readonly": true, "type": "array" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content of the note.", "readonly": true, "type": "string" }, "content_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content data for the note. JSON string. Available for re-localisation.", "readonly": true, "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date the note was created.", "readonly": true, "type": "string" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date the note was created (GMT).", "readonly": true, "type": "string" }, "date_reminder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date after which the user should be reminded of the note, if any.", "readonly": true, "type": "string" }, "date_reminder_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date after which the user should be reminded of the note, if any (GMT).", "readonly": true, "type": "string" }, - "id": { "context": ["view"], "description": "ID of the note record.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "view" + ], + "description": "ID of the note record.", + "readonly": true, + "type": "integer" + }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The image of the note, if any.", "readonly": true, "type": "string" }, "is_deleted": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Registers whether the note is deleted or not", "readonly": true, "type": "boolean" }, "is_read": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Registers whether the note is read or not", "readonly": true, "type": "boolean" }, "is_snoozable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not a user can request to be reminded about the note.", "readonly": true, "type": "boolean" }, "layout": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The layout of the note (eg banner, thumbnail, plain).", "readonly": true, "type": "string" }, "locale": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Locale used for the note title and content.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the note.", "readonly": true, "type": "string" }, "source": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Source of the note.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The status of the note (e.g. unactioned, actioned).", "type": "string" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Title of the note.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The type of the note (eg error, warning, etc).", "readonly": true, "type": "string" @@ -5058,112 +8223,187 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "business_extensions": { - "context": ["view"], + "context": [ + "view" + ], "description": "Extra business extensions to install.", "readonly": true, "type": "array" }, "completed": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not the profile was completed.", "readonly": true, "type": "boolean" }, - "industry": { "context": ["view"], "description": "Industry.", "readonly": true, "type": "array" }, + "industry": { + "context": [ + "view" + ], + "description": "Industry.", + "readonly": true, + "type": "array" + }, "is_agree_marketing": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "readonly": true, "type": "boolean" }, "is_plugins_page_skipped": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not plugins step in core profiler was skipped.", "readonly": true, "type": "boolean" }, "is_store_country_set": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not this store country is set via onboarding profiler.", "readonly": true, "type": "boolean" }, "number_employees": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of employees of the store.", - "enum": ["1", "<10", "10-50", "50-250", "+250", "not specified"], + "enum": [ + "+250", + "<10", + "1", + "10-50", + "50-250", + "not specified" + ], "readonly": true, "type": "string" }, "other_platform": { - "context": ["view"], + "context": [ + "view" + ], "description": "Name of other platform used to sell.", - "enum": ["shopify", "bigcommerce", "magento", "wix", "amazon", "ebay", "etsy", "squarespace", "other"], + "enum": [ + "amazon", + "bigcommerce", + "ebay", + "etsy", + "magento", + "other", + "shopify", + "squarespace", + "wix" + ], "readonly": true, "type": "string" }, "other_platform_name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Name of other platform used to sell (not listed).", "readonly": true, "type": "string" }, "product_count": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of products to be added.", - "enum": ["0", "1-10", "11-100", "101-1000", "1000+"], + "enum": [ + "0", + "1-10", + "1000+", + "101-1000", + "11-100" + ], "readonly": true, "type": "string" }, "product_types": { - "context": ["view"], + "context": [ + "view" + ], "description": "Types of products sold.", "readonly": true, "type": "array" }, "revenue": { - "context": ["view"], + "context": [ + "view" + ], "description": "Current annual revenue of the store.", "enum": [ - "none", - "up-to-2500", - "2500-10000", "10000-50000", + "2500-10000", "50000-250000", "more-than-250000", - "rather-not-say" + "none", + "rather-not-say", + "up-to-2500" ], "readonly": true, "type": "string" }, "selling_venues": { - "context": ["view"], + "context": [ + "view" + ], "description": "Other places the store is selling products.", - "enum": ["no", "other", "brick-mortar", "brick-mortar-other", "other-woocommerce"], + "enum": [ + "brick-mortar", + "brick-mortar-other", + "no", + "other", + "other-woocommerce" + ], "readonly": true, "type": "string" }, "setup_client": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not this store was setup for a client.", "readonly": true, "type": "boolean" }, "skipped": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not the profile was skipped.", "readonly": true, "type": "boolean" }, "store_email": { - "context": ["view"], + "context": [ + "view" + ], "description": "Store email address.", "readonly": true, "type": "string" }, - "theme": { "context": ["view"], "description": "Selected store theme.", "readonly": true, "type": "string" }, + "theme": { + "context": [ + "view" + ], + "description": "Selected store theme.", + "readonly": true, + "type": "string" + }, "wccom_connected": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", "readonly": true, "type": "boolean" @@ -5175,9 +8415,33 @@ "onboarding_theme": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view", "edit"], "description": "Theme name.", "readonly": true, "type": "string" }, - "slug": { "context": ["view", "edit"], "description": "Theme slug.", "readonly": true, "type": "string" }, - "status": { "context": ["view", "edit"], "description": "Theme status.", "readonly": true, "type": "string" } + "name": { + "context": [ + "edit", + "view" + ], + "description": "Theme name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Theme slug.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Theme status.", + "readonly": true, + "type": "string" + } }, "title": "onboarding_theme", "type": "object" @@ -5186,7 +8450,9 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "options": { - "context": ["view"], + "context": [ + "view" + ], "description": "Array of options with associated values.", "readonly": true, "type": "array" @@ -5199,81 +8465,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "billing_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current set billing address for the customer.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "readonly": true, "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "readonly": true, "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "readonly": true, "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "readonly": true, "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "readonly": true, "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "readonly": true, "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "readonly": true, "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "readonly": true, "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "readonly": true, "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "readonly": true, "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "readonly": true, "required": true, @@ -5284,76 +8586,115 @@ "type": "object" }, "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of applied basket coupons.", "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The coupon's unique code.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The discount type for the coupon (eg percentage or fixed amount)", "readonly": true, "type": "string" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount applied by this coupon.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount applied by this coupon.", "readonly": true, "type": "string" @@ -5369,18 +8710,27 @@ "type": "array" }, "errors": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket item errors, for example, items in the basket which are out of stock.", "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Error code", "readonly": true, "type": "string" }, "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Error message", "readonly": true, "type": "string" @@ -5391,81 +8741,138 @@ "readonly": true, "type": "array" }, - "id": { "context": ["view", "edit"], "description": "The order ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The order ID.", + "readonly": true, + "type": "integer" + }, "items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line items data.", "items": { "properties": { "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if backorders are allowed past stock availability.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "catalog_visibility": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether the product is visible in the catalogue", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product full description in HTML format.", "readonly": true, "type": "string" }, - "extensions": { "context": ["view", "edit"], "properties": [], "readonly": true, "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item product or variation ID.", "readonly": true, "type": "integer" }, "images": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of images.", "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "readonly": true, "type": "string" }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "readonly": true, "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "readonly": true, "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "readonly": true, "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "readonly": true, @@ -5478,24 +8885,36 @@ "type": "array" }, "item_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Metadata related to the item", "items": { "properties": { "display": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Optionally, how the metadata value should be displayed to the user.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the metadata.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Value of the metadata.", "readonly": true, "type": "string" @@ -5507,142 +8926,220 @@ "type": "array" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the item.", "readonly": true, "type": "string" }, "low_stock_remaining": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity left in stock if stock is low, or null if not applicable.", "readonly": true, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, "type": "string" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product URL.", "format": "uri", "readonly": true, "type": "string" }, "prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price data for the product in the current line item, including or excluding taxes based on the \"display prices during basket and checkout\" setting. Provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price range, if applicable.", "properties": { "max_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" }, "min_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "raw_prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", "properties": { "precision": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal precision of the returned prices.", "readonly": true, "type": "integer" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" @@ -5652,36 +9149,54 @@ "type": "object" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of this item.", "readonly": true, "type": "number" }, "quantity_limits": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How the quantity of this item should be controlled, for example, any limits in place.", "properties": { "editable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "If the quantity is editable or fixed.", "readonly": true, "type": "boolean" }, "maximum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The maximum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "minimum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The minimum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "multiple_of": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 1, "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", "readonly": true, @@ -5692,95 +9207,145 @@ "type": "object" }, "short_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product short description in HTML format.", "readonly": true, "type": "string" }, "show_backorder_badge": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the product is on backorder.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock keeping unit, if applicable.", "readonly": true, "type": "string" }, "sold_individually": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If true, only one item of this product is allowed for purchase in a single order.", "readonly": true, "type": "boolean" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "line_subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (the price of the product before coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax.", "readonly": true, "type": "string" }, "line_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (the price of the product after coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax.", "readonly": true, "type": "string" @@ -5790,24 +9355,36 @@ "type": "object" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item type.", "readonly": true, "type": "string" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Chosen attributes (for variations).", "items": { "properties": { "attribute": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute name.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute value.", "readonly": true, "type": "string" @@ -5824,92 +9401,134 @@ "type": "array" }, "needs_payment": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.", "readonly": true, "type": "boolean" }, "needs_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.", "readonly": true, "type": "boolean" }, "payment_requirements": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of required payment gateway features to process the order.", "readonly": true, "type": "array" }, "shipping_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current set shipping address for the customer.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "readonly": true, "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "readonly": true, "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "readonly": true, "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "readonly": true, "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "readonly": true, "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "readonly": true, "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "readonly": true, "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "readonly": true, "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "readonly": true, "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "readonly": true, "required": true, @@ -5920,82 +9539,124 @@ "type": "object" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Status of the order.", "readonly": true, "type": "string" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order totals.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Subtotal of the order.", "readonly": true, "type": "string" }, "tax_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Lines of taxes applied to items and shipping.", "items": { "properties": { "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The name of the tax.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The amount of tax charged.", "readonly": true, "type": "string" }, "rate": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The rate at which tax is applied.", "readonly": true, "type": "string" @@ -6007,67 +9668,106 @@ "type": "array" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount from applied coupons.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount from applied coupons.", "readonly": true, "type": "string" }, "total_fees": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of any applied fees.", "readonly": true, "type": "string" }, "total_fees_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on fees.", "readonly": true, "type": "string" }, "total_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of items in the order.", "readonly": true, "type": "string" }, "total_items_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on items in the order.", "readonly": true, "type": "string" }, "total_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price the customer will pay.", "readonly": true, "type": "string" }, "total_refund": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total refund applied to the order.", "readonly": true, "type": "string" }, "total_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of shipping.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "total_shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax applied to the order.", "readonly": true, "type": "string" @@ -6084,30 +9784,49 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "customer_note": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "type": "boolean" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order note was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order note was created, as GMT.", "readonly": true, "type": "date-time" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "note": { "context": ["view", "edit"], "description": "Order note content.", "type": "string" } + "note": { + "context": [ + "edit", + "view" + ], + "description": "Order note content.", + "type": "string" + } }, "title": "order_note", "type": "object" @@ -6119,7 +9838,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -6127,58 +9854,103 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", "rel": "https:/api.w.org/action-assign-author", - "targetSchema": { "properties": { "author": { "type": "integer" } }, "type": "object" }, + "targetSchema": { + "properties": { + "author": { + "type": "integer" + } + }, + "type": "object" + }, "title": "The current user can change the author on this post." } ], "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the post.", "type": "integer" }, "class_list": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of the class names for the post container element.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "comment_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -6187,34 +9959,61 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -6223,28 +10022,42 @@ "type": "object" }, "featured_media": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the featured media for the post.", "type": "integer" }, "generated_slug": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Slug automatically generated from the post title.", "readonly": true, "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -6254,106 +10067,165 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "menu_order": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The order of the post in relation to other posts.", "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", - "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "parent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID for the parent of the object.", "type": "integer" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "permalink_template": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Permalink template for the post.", "readonly": true, "type": "string" }, "ping_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -6362,7 +10234,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -6375,33 +10251,51 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -6410,34 +10304,55 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -6446,17 +10361,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -6466,56 +10389,95 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", - "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -6531,52 +10493,89 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "block_types": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "The block types which can use this pattern.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "uniqueItems": true }, "categories": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern's category slugs.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "uniqueItems": true }, "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern content.", "minLength": 1, "type": "string" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "A description of the pattern.", "minLength": 1, "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern ID.", "minimum": 1, "type": "integer" }, "keywords": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern's keywords.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "uniqueItems": true }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern title, in human readable format.", "minLength": 1, "type": "string" }, "viewport_width": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The preferred width of the viewport when previewing a pattern, in pixels.", "type": "integer" } @@ -6594,35 +10593,77 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Suggestion description.", "readonly": true, "type": "string" }, - "id": { "context": ["view", "edit"], "description": "Suggestion ID.", "readonly": true, "type": "string" }, - "image": { "context": ["view", "edit"], "description": "Gateway image.", "readonly": true, "type": "string" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Suggestion ID.", + "readonly": true, + "type": "string" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Gateway image.", + "readonly": true, + "type": "string" + }, "is_visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Suggestion visibility.", "readonly": true, "type": "boolean" }, "plugins": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Array of plugin slugs.", "readonly": true, "type": "array" }, "recommendation_priority": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Priority of recommendation.", "readonly": true, "type": "integer" }, - "title": { "context": ["view", "edit"], "description": "Gateway title.", "readonly": true, "type": "string" }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Gateway title.", + "readonly": true, + "type": "string" + }, "transaction_processors": { - "addtionalProperties": { "format": "uri", "type": "string" }, - "context": ["view", "edit"], + "addtionalProperties": { + "format": "uri", + "type": "string" + }, + "context": [ + "edit", + "view" + ], "description": "Array of transaction processors and their images.", "readonly": true, "type": "object" @@ -6635,99 +10676,155 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway description on checkout.", "type": "string" }, "enabled": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway enabled status.", "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway ID.", "readonly": true, "type": "string" }, "method_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway method description.", "readonly": true, "type": "string" }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway method title.", "readonly": true, "type": "string" }, - "order": { "context": ["view", "edit"], "description": "Payment gateway sort order.", "type": "integer" }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway sort order.", + "type": "integer" + }, "settings": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", + "checkbox", "color", - "password", - "textarea", - "select", - "multiselect", - "radio", + "email", "image_width", - "checkbox" + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Setting value.", "type": "string" } + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } }, "type": "object" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway title on checkout.", "type": "string" } @@ -6739,80 +10836,131 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin author.", "readonly": true, "type": "object" }, "author_uri": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin author's website address.", "format": "uri", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin description.", "properties": { - "raw": { "description": "The raw plugin description.", "type": "string" }, - "rendered": { "description": "The plugin description formatted for display.", "type": "string" } + "raw": { + "description": "The raw plugin description.", + "type": "string" + }, + "rendered": { + "description": "The plugin description formatted for display.", + "type": "string" + } }, "readonly": true, "type": "object" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The plugin name.", "readonly": true, "type": "string" }, "network_only": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the plugin can only be activated network wide.", "readonly": true, "type": "boolean" }, "plugin": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The plugin file.", "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", "readonly": true, "type": "string" }, "plugin_uri": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin's website address.", "format": "uri", "readonly": true, "type": "string" }, "requires_php": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Minimum required version of PHP.", "readonly": true, "type": "string" }, "requires_wp": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Minimum required version of WordPress.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The plugin activation status.", - "enum": ["inactive", "active"], + "enum": [ + "active", + "inactive" + ], "type": "string" }, "textdomain": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin's text domain.", "readonly": true, "type": "string" }, "version": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin version number.", "readonly": true, "type": "string" @@ -6825,13 +10973,32 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "connectAction": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Action that should be completed to connect Jetpack.", "readonly": true, "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Plugin name.", "readonly": true, "type": "string" }, - "slug": { "context": ["view", "edit"], "description": "Plugin slug.", "readonly": true, "type": "string" } + "name": { + "context": [ + "edit", + "view" + ], + "description": "Plugin name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Plugin slug.", + "readonly": true, + "type": "string" + } }, "title": "plugins", "type": "object" @@ -6843,7 +11010,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -6851,26 +11026,56 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-sticky", - "targetSchema": { "properties": { "sticky": { "type": "boolean" } }, "type": "object" }, + "targetSchema": { + "properties": { + "sticky": { + "type": "boolean" + } + }, + "type": "object" + }, "title": "The current user can sticky this post." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-assign-author", - "targetSchema": { "properties": { "author": { "type": "integer" } }, "type": "object" }, + "targetSchema": { + "properties": { + "author": { + "type": "integer" + } + }, + "type": "object" + }, "title": "The current user can change the author on this post." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-assign-categories", "targetSchema": { - "properties": { "categories": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "categories": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the category taxonomy." @@ -6879,7 +11084,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-create-categories", "targetSchema": { - "properties": { "categories": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "categories": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the category taxonomy." @@ -6888,7 +11100,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-assign-tags", "targetSchema": { - "properties": { "tags": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "tags": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the post_tag taxonomy." @@ -6897,7 +11116,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-create-tags", "targetSchema": { - "properties": { "tags": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "tags": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the post_tag taxonomy." @@ -6905,52 +11131,86 @@ ], "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the post.", "type": "integer" }, "categories": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the category taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "class_list": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of the class names for the post container element.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "comment_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -6959,34 +11219,61 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -6995,34 +11282,62 @@ "type": "object" }, "featured_media": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the featured media for the post.", "type": "integer" }, "format": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The format for the post.", - "enum": ["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio"], + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], "type": "string" }, "generated_slug": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Slug automatically generated from the post title.", "readonly": true, "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -7032,107 +11347,168 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", - "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "permalink_template": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Permalink template for the post.", "readonly": true, "type": "string" }, "ping_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "sticky": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post should be treated as sticky.", "type": "boolean" }, "tags": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the post_tag taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -7141,7 +11517,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -7154,33 +11534,51 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -7189,34 +11587,55 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -7225,17 +11644,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -7245,56 +11672,95 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", - "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -7313,7 +11779,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -7321,14 +11795,30 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-assign-product_cat", "targetSchema": { - "properties": { "product_cat": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "product_cat": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the product_cat taxonomy." @@ -7337,7 +11827,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-create-product_cat", "targetSchema": { - "properties": { "product_cat": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "product_cat": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the product_cat taxonomy." @@ -7346,7 +11843,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-assign-product_tag", "targetSchema": { - "properties": { "product_tag": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "product_tag": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the product_tag taxonomy." @@ -7355,7 +11859,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-create-product_tag", "targetSchema": { - "properties": { "product_tag": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "product_tag": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the product_tag taxonomy." @@ -7363,35 +11874,54 @@ ], "properties": { "class_list": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of the class names for the post container element.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -7400,34 +11930,61 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -7436,28 +11993,42 @@ "type": "object" }, "featured_media": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the featured media for the post.", "type": "integer" }, "generated_slug": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Slug automatically generated from the post title.", "readonly": true, "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -7467,97 +12038,153 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "permalink_template": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Permalink template for the post.", "readonly": true, "type": "string" }, "product_cat": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the product_cat taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "product_tag": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the product_tag taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -7566,7 +12193,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -7579,48 +12210,94 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of objects (posts of any type) assigned to the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Term description.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Category image.", "properties": { - "alt": { "context": ["view", "edit"], "description": "Image alternative text.", "type": "string" }, - "id": { "context": ["view", "edit"], "description": "Image ID.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Image name.", "type": "string" }, + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "type": "string" @@ -7629,28 +12306,49 @@ "readonly": true, "type": "object" }, - "name": { "context": ["view", "edit"], "description": "Term name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "readonly": true, + "type": "string" + }, "parent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent term ID, if applicable.", "readonly": true, "type": "integer" }, "permalink": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Category URL.", "format": "uri", "readonly": true, "type": "string" }, "review_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of reviews for products in this category.", "readonly": true, "type": "integer" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "String based identifier for the term.", "readonly": true, "type": "string" @@ -7663,98 +12361,157 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "attribute_counts": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Returns number of products within attribute terms.", "items": { "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of products.", "readonly": true, "type": "integer" }, - "term": { "context": ["view", "edit"], "description": "Term ID", "readonly": true, "type": "integer" } + "term": { + "context": [ + "edit", + "view" + ], + "description": "Term ID", + "readonly": true, + "type": "integer" + } }, "type": "object" }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Min and max prices found in collection of products, provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "max_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Maximum price found in collection of products.", "readonly": true, "type": "string" }, "min_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Minimum price found in collection of products.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "rating_counts": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Returns number of products with each average rating.", "items": { "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of products.", "readonly": true, "type": "integer" }, "rating": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average rating", "readonly": true, "type": "integer" @@ -7763,25 +12520,45 @@ "type": "object" }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "stock_status_counts": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Returns number of products with each stock status.", "items": { "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of products.", "readonly": true, "type": "integer" }, - "status": { "context": ["view", "edit"], "description": "Status", "readonly": true, "type": "string" } + "status": { + "context": [ + "edit", + "view" + ], + "description": "Status", + "readonly": true, + "type": "string" + } }, "type": "object" }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] } }, "title": "product-collection-data", @@ -7791,33 +12568,51 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -7826,34 +12621,55 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -7862,17 +12678,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -7882,51 +12706,89 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -7942,35 +12804,64 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "has_archives": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Enable/Disable attribute archives.", "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Attribute name.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, "order_by": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "menu_order", "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "select", "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "type": "string" } }, @@ -7981,30 +12872,52 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published products for the resource.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the resource.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "menu_order": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Term name.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "type": "string" + }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } @@ -8016,46 +12929,89 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, - "parent": { "context": ["view", "edit"], "description": "The parent term ID.", "type": "integer" }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The parent term ID.", + "type": "integer" + }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["product_cat"], + "enum": [ + "product_cat" + ], "readonly": true, "type": "string" } @@ -8067,27 +13023,67 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the review was created, in the site's timezone.", "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the review was created, as GMT.", "type": "date-time" }, - "email": { "context": ["view", "edit"], "description": "Reviewer email.", "type": "string" }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Reviewer email.", + "type": "string" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Reviewer name.", "type": "string" }, - "rating": { "context": ["view", "edit"], "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "context": ["view", "edit"], "description": "The content of the review.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "context": [ + "edit", + "view" + ], + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "context": [ + "edit", + "view" + ], + "description": "The content of the review.", + "type": "string" + }, "verified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the reviewer bought the product or not.", "readonly": true, "type": "boolean" @@ -8100,25 +13096,44 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published products for the resource.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the resource.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Shipping class name.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Shipping class name.", + "type": "string" + }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } @@ -8130,45 +13145,81 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["product_tag"], + "enum": [ + "product_tag" + ], "readonly": true, "type": "string" } @@ -8180,14 +13231,34 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of attributes.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Attribute ID.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Attribute name.", "type": "string" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -8197,231 +13268,487 @@ "type": "array" }, "backordered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on back-order.", "readonly": true, "type": "boolean" }, "backorders": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "type": "string" }, "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if back-orders are allowed.", "readonly": true, "type": "boolean" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_on_sale_from": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Start date of sale price, in the site's timezone.", "type": "date-time" }, "date_on_sale_from_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Start date of sale price, as GMT.", "type": "date-time" }, "date_on_sale_to": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "End date of sale price, in the site's timezone.", "type": "date-time" }, "date_on_sale_to_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "End date of sale price, as GMT.", "type": "date-time" }, - "description": { "context": ["view", "edit"], "description": "Variation description.", "type": "string" }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Variation description.", + "type": "string" + }, "dimensions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation dimensions.", "properties": { - "height": { "context": ["view", "edit"], "description": "Variation height (cm).", "type": "string" }, - "length": { "context": ["view", "edit"], "description": "Variation length (cm).", "type": "string" }, - "width": { "context": ["view", "edit"], "description": "Variation width (cm).", "type": "string" } + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } }, "type": "object" }, "download_expiry": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "download_limit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "downloadable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of downloadable files.", "items": { "properties": { - "file": { "context": ["view", "edit"], "description": "File URL.", "type": "string" }, - "id": { "context": ["view", "edit"], "description": "File ID.", "type": "string" }, - "name": { "context": ["view", "edit"], "description": "File name.", "type": "string" } + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } }, "type": "object" }, "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation image data.", "properties": { - "alt": { "context": ["view", "edit"], "description": "Image alternative text.", "type": "string" }, + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": "date-time" }, - "id": { "context": ["view", "edit"], "description": "Image ID.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Image name.", "type": "string" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, - "src": { "context": ["view", "edit"], "description": "Image URL.", "format": "uri", "type": "string" } + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } }, "type": "object" }, "in_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Stock management at variation level.", "type": "mixed" }, "menu_order": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Menu order, used to custom sort products.", "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "on_sale": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on sale.", "readonly": true, "type": "boolean" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation URL.", "format": "uri", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current variation price.", "readonly": true, "type": "string" }, "purchasable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation can be bought.", "readonly": true, "type": "boolean" }, - "regular_price": { "context": ["view", "edit"], "description": "Variation regular price.", "type": "string" }, - "sale_price": { "context": ["view", "edit"], "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "context": ["view", "edit"], "description": "Shipping class slug.", "type": "string" }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "context": [ + "edit", + "view" + ], + "description": "Shipping class slug.", + "type": "string" + }, "shipping_class_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping class ID.", "readonly": true, "type": "string" }, - "sku": { "context": ["view", "edit"], "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "context": ["view", "edit"], "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "context": ["view", "edit"], "description": "Tax class.", "type": "string" }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "context": [ + "edit", + "view" + ], + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class.", + "type": "string" + }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "type": "string" }, "virtual": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is virtual.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "context": ["view", "edit"], "description": "Variation weight (kg).", "type": "string" } + "weight": { + "context": [ + "edit", + "view" + ], + "description": "Variation weight (kg).", + "type": "string" + } }, "title": "product_variation", "type": "object" @@ -8429,7 +13756,14 @@ "rendered-block": { "$schema": "http:/json-schema.org/schema#", "properties": { - "rendered": { "context": ["edit"], "description": "The rendered block.", "required": true, "type": "string" } + "rendered": { + "context": [ + "edit" + ], + "description": "The rendered block.", + "required": true, + "type": "string" + } }, "title": "rendered-block", "type": "object" @@ -8438,13 +13772,17 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "A human-readable description of the resource.", "readonly": true, "type": "string" }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" @@ -8457,34 +13795,57 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "category_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "readonly": true, "type": "integer" }, "extended_info": { - "name": { "context": ["view", "edit"], "description": "Category name.", "readonly": true, "type": "string" } + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name.", + "readonly": true, + "type": "string" + } }, "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of items sold.", "readonly": true, "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "products_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of products.", "readonly": true, "type": "integer" @@ -8496,14 +13857,30 @@ "report_coupon_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Coupon type name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Coupon type name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of coupons.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of coupons.", + "readonly": true, + "type": "string" + } }, "title": "report_coupon_total", "type": "object" @@ -8512,53 +13889,89 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "readonly": true, "type": "number" }, "coupon_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon ID.", "readonly": true, "type": "integer" }, "extended_info": { - "code": { "context": ["view", "edit"], "description": "Coupon code.", "readonly": true, "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "readonly": true, + "type": "string" + }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon creation date.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon creation date in GMT.", "readonly": true, "type": "date-time" }, "date_expires": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon expiration date.", "readonly": true, "type": "date-time" }, "date_expires_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon expiration date in GMT.", "readonly": true, "type": "date-time" }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon discount type.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "readonly": true, "type": "string" } }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -8571,51 +13984,80 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "format": "currency", "indicator": true, @@ -8623,13 +14065,19 @@ "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of coupons.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of discounted orders.", "indicator": true, "readonly": true, @@ -8637,22 +14085,34 @@ "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "format": "currency", "indicator": true, @@ -8660,13 +14120,19 @@ "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of coupons.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of discounted orders.", "indicator": true, "readonly": true, @@ -8694,11 +14160,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "format": "currency", "indicator": true, @@ -8706,13 +14178,19 @@ "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of coupons.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of discounted orders.", "indicator": true, "readonly": true, @@ -8720,22 +14198,34 @@ "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "format": "currency", "indicator": true, @@ -8743,13 +14233,19 @@ "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of coupons.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of discounted orders.", "indicator": true, "readonly": true, @@ -8777,14 +14273,30 @@ "report_customer_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Customer type name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Customer type name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of customers.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of customers.", + "readonly": true, + "type": "string" + } }, "title": "report_customer_total", "type": "object" @@ -8793,65 +14305,140 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "avg_order_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average order value", "readonly": true, "type": "number" }, - "city": { "context": ["view", "edit"], "description": "City.", "readonly": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City.", + "readonly": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region.", "readonly": true, "type": "string" }, "date_last_active": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date last active.", "readonly": true, "type": "date-time" }, "date_last_active_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date last active GMT.", "readonly": true, "type": "date-time" }, "date_registered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date registered.", "readonly": true, "type": "date-time" }, "date_registered_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date registered GMT.", "readonly": true, "type": "date-time" }, - "id": { "context": ["view", "edit"], "description": "Customer ID.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Name.", "readonly": true, "type": "string" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name.", + "readonly": true, + "type": "string" + }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order count.", "readonly": true, "type": "integer" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "readonly": true, "type": "string" }, - "state": { "context": ["view", "edit"], "description": "Region.", "readonly": true, "type": "string" }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "Region.", + "readonly": true, + "type": "string" + }, "total_spend": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total spend.", "readonly": true, "type": "number" }, - "user_id": { "context": ["view", "edit"], "description": "User ID.", "readonly": true, "type": "integer" }, - "username": { "context": ["view", "edit"], "description": "Username.", "readonly": true, "type": "string" } + "user_id": { + "context": [ + "edit", + "view" + ], + "description": "User ID.", + "readonly": true, + "type": "integer" + }, + "username": { + "context": [ + "edit", + "view" + ], + "description": "Username.", + "readonly": true, + "type": "string" + } }, "title": "report_customers", "type": "object" @@ -8860,31 +14447,46 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "avg_avg_order_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average AOV per customer.", "format": "currency", "readonly": true, "type": "number" }, "avg_orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average number of orders.", "readonly": true, "type": "integer" }, "avg_total_spend": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average total spend per customer.", "format": "currency", "readonly": true, "type": "number" }, "customers_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of customers.", "readonly": true, "type": "integer" @@ -8901,53 +14503,109 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date of the download, in the site's time zone.", "readonly": true, "type": "date-time" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date of the download, as GMT.", "readonly": true, "type": "date-time" }, "download_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Download ID.", "readonly": true, "type": "string" }, - "file_name": { "context": ["view", "edit"], "description": "File name.", "readonly": true, "type": "string" }, - "file_path": { "context": ["view", "edit"], "description": "File URL.", "readonly": true, "type": "string" }, - "id": { "context": ["view", "edit"], "description": "ID.", "readonly": true, "type": "integer" }, + "file_name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "readonly": true, + "type": "string" + }, + "file_path": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "ID.", + "readonly": true, + "type": "integer" + }, "ip_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "IP address for the downloader.", "readonly": true, "type": "string" }, - "order_id": { "context": ["view", "edit"], "description": "Order ID.", "readonly": true, "type": "integer" }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, "order_number": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order Number.", "readonly": true, "type": "string" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "integer" }, "user_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "User ID for the downloader.", "readonly": true, "type": "integer" }, "username": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "User name of the downloader.", "readonly": true, "type": "string" @@ -8959,15 +14617,29 @@ "report_export": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "export_id": { "context": ["view", "edit"], "description": "Export ID.", "readonly": true, "type": "string" }, + "export_id": { + "context": [ + "edit", + "view" + ], + "description": "Export ID.", + "readonly": true, + "type": "string" + }, "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Export status message.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Export status.", "readonly": true, "type": "string" @@ -8980,13 +14652,19 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "download_url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Export download URL.", "readonly": true, "type": "string" }, "percent_complete": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Percentage complete.", "readonly": true, "type": "int" @@ -8999,13 +14677,19 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regenerate data message.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regeneration status.", "readonly": true, "type": "string" @@ -9017,14 +14701,30 @@ "report_order_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Order status name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Order status name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of orders.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of orders.", + "readonly": true, + "type": "string" + } }, "title": "report_order_total", "type": "object" @@ -9033,77 +14733,129 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "customer_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Customer ID.", "readonly": true, "type": "integer" }, "customer_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Returning or new customer.", "readonly": true, "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date the order was created, in the site's time zone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date the order was created, as GMT.", "readonly": true, "type": "date-time" }, "extended_info": { "attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order attribution information.", "readonly": true, "type": "object" }, "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of order coupons.", "readonly": true, "type": "array" }, "customer": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order customer information.", "readonly": true, "type": "object" }, "products": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of order product IDs, names, quantities.", "readonly": true, "type": "array" } }, "net_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net total revenue.", "readonly": true, "type": "float" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of items sold.", "readonly": true, "type": "integer" }, - "order_id": { "context": ["view", "edit"], "description": "Order ID.", "readonly": true, "type": "integer" }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, "order_number": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order Number.", "readonly": true, "type": "string" }, - "status": { "context": ["view", "edit"], "description": "Order status.", "readonly": true, "type": "string" }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Order status.", + "readonly": true, + "type": "string" + }, "total_formatted": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net total revenue (formatted).", "readonly": true, "type": "string" @@ -9116,47 +14868,76 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "readonly": true, "type": "date-time" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "readonly": true, "type": "date-time" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "readonly": true, "type": "date-time" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "readonly": true, "type": "date-time" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "download_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of downloads.", "indicator": true, "readonly": true, @@ -9174,11 +14955,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "download_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of downloads.", "indicator": true, "readonly": true, @@ -9197,36 +14984,45 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "chart": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The specific chart this stat referrers to.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable label for the stat.", "readonly": true, "type": "string" }, "stat": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "enum": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "readonly": true, "type": "string" @@ -9238,14 +15034,30 @@ "report_product_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Product type name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Product type name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of products.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of products.", + "readonly": true, + "type": "string" + } }, "title": "report_product_total", "type": "object" @@ -9255,76 +15067,128 @@ "properties": { "extended_info": { "category_ids": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product category IDs.", "readonly": true, "type": "array" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product image.", "readonly": true, "type": "string" }, "low_stock_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory threshold for low stock.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product link.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, - "sku": { "context": ["view", "edit"], "description": "Product SKU.", "readonly": true, "type": "string" }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, "stock_quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory quantity.", "readonly": true, "type": "integer" }, "stock_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory status.", "readonly": true, "type": "string" }, "variations": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product variations IDs.", "readonly": true, "type": "array" } }, "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of items sold.", "readonly": true, "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total Net sales of all items sold.", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders product appeared in.", "readonly": true, "type": "integer" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "integer" @@ -9337,51 +15201,80 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of product items sold.", "indicator": true, "readonly": true, @@ -9389,42 +15282,68 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "segment_label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable segment label, either product or variation name.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of product items sold.", "indicator": true, "readonly": true, @@ -9432,14 +15351,20 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -9465,11 +15390,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of product items sold.", "indicator": true, "readonly": true, @@ -9477,42 +15408,68 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "segment_label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable segment label, either product or variation name.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of product items sold.", "indicator": true, "readonly": true, @@ -9520,14 +15477,20 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -9554,64 +15517,99 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount discounted by coupons.", "readonly": true, "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique coupons count.", "format": "currency", "readonly": true, "type": "number" }, "gross_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Gross sales.", "format": "currency", "indicator": true, @@ -9619,7 +15617,10 @@ "type": "number" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "indicator": true, @@ -9627,19 +15628,28 @@ "type": "number" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Items sold.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of returns.", "format": "currency", "indicator": true, @@ -9648,35 +15658,53 @@ "type": "number" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount discounted by coupons.", "readonly": true, "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique coupons count.", "format": "currency", "readonly": true, "type": "number" }, "gross_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Gross sales.", "format": "currency", "indicator": true, @@ -9684,7 +15712,10 @@ "type": "number" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "indicator": true, @@ -9692,19 +15723,28 @@ "type": "number" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Items sold.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of returns.", "format": "currency", "indicator": true, @@ -9713,7 +15753,10 @@ "type": "number" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of shipping.", "format": "currency", "indicator": true, @@ -9722,14 +15765,20 @@ "type": "number" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of taxes.", "format": "currency", "readonly": true, "type": "number" }, "total_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "format": "currency", "indicator": true, @@ -9747,7 +15796,10 @@ "type": "array" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of shipping.", "format": "currency", "indicator": true, @@ -9756,14 +15808,20 @@ "type": "number" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of taxes.", "format": "currency", "readonly": true, "type": "number" }, "total_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "format": "currency", "indicator": true, @@ -9781,24 +15839,36 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount discounted by coupons.", "readonly": true, "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique coupons count.", "format": "currency", "readonly": true, "type": "number" }, "gross_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Gross sales.", "format": "currency", "indicator": true, @@ -9806,7 +15876,10 @@ "type": "number" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "indicator": true, @@ -9814,25 +15887,37 @@ "type": "number" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Items sold.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "products": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Products sold.", "readonly": true, "type": "integer" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of returns.", "format": "currency", "indicator": true, @@ -9841,35 +15926,53 @@ "type": "number" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount discounted by coupons.", "readonly": true, "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique coupons count.", "format": "currency", "readonly": true, "type": "number" }, "gross_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Gross sales.", "format": "currency", "indicator": true, @@ -9877,7 +15980,10 @@ "type": "number" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "indicator": true, @@ -9885,19 +15991,28 @@ "type": "number" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Items sold.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of returns.", "format": "currency", "indicator": true, @@ -9906,7 +16021,10 @@ "type": "number" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of shipping.", "format": "currency", "indicator": true, @@ -9915,14 +16033,20 @@ "type": "number" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of taxes.", "format": "currency", "readonly": true, "type": "number" }, "total_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "format": "currency", "indicator": true, @@ -9940,7 +16064,10 @@ "type": "array" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of shipping.", "format": "currency", "indicator": true, @@ -9949,14 +16076,20 @@ "type": "number" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of taxes.", "format": "currency", "readonly": true, "type": "number" }, "total_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "format": "currency", "indicator": true, @@ -9974,14 +16107,30 @@ "report_review_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Review type name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Review type name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of reviews.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of reviews.", + "readonly": true, + "type": "string" + } }, "title": "report_review_total", "type": "object" @@ -9990,40 +16139,70 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "manage_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Manage stock.", "readonly": true, "type": "boolean" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, "parent_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product parent ID.", "readonly": true, "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier.", "readonly": true, "type": "string" }, "stock_quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock quantity.", "readonly": true, "type": "integer" }, "stock_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "readonly": true, "type": "string" } @@ -10035,35 +16214,95 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region.", "readonly": true, "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Tax rate name.", "readonly": true, "type": "string" }, - "order_tax": { "context": ["view", "edit"], "description": "Order tax.", "readonly": true, "type": "number" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate name.", + "readonly": true, + "type": "string" + }, + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "readonly": true, + "type": "number" + }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, - "priority": { "context": ["view", "edit"], "description": "Priority.", "readonly": true, "type": "integer" }, + "priority": { + "context": [ + "edit", + "view" + ], + "description": "Priority.", + "readonly": true, + "type": "integer" + }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "readonly": true, "type": "number" }, - "state": { "context": ["view", "edit"], "description": "State.", "readonly": true, "type": "string" }, - "tax_rate": { "context": ["view", "edit"], "description": "Tax rate.", "readonly": true, "type": "number" }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State.", + "readonly": true, + "type": "string" + }, + "tax_rate": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate.", + "readonly": true, + "type": "number" + }, "tax_rate_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, - "total_tax": { "context": ["view", "edit"], "description": "Total tax.", "readonly": true, "type": "number" } + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "readonly": true, + "type": "number" + } }, "title": "report_taxes", "type": "object" @@ -10072,51 +16311,80 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "order_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order tax.", "format": "currency", "indicator": true, @@ -10124,28 +16392,43 @@ "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "order_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order tax.", "format": "currency", "indicator": true, @@ -10153,13 +16436,19 @@ "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "format": "currency", "indicator": true, @@ -10167,13 +16456,19 @@ "type": "number" }, "tax_codes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of tax codes.", "readonly": true, "type": "integer" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax.", "format": "currency", "indicator": true, @@ -10191,7 +16486,10 @@ "type": "array" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "format": "currency", "indicator": true, @@ -10199,13 +16497,19 @@ "type": "number" }, "tax_codes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of tax codes.", "readonly": true, "type": "integer" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax.", "format": "currency", "indicator": true, @@ -10223,11 +16527,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "order_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order tax.", "format": "currency", "indicator": true, @@ -10235,28 +16545,43 @@ "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "order_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order tax.", "format": "currency", "indicator": true, @@ -10264,13 +16589,19 @@ "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "format": "currency", "indicator": true, @@ -10278,13 +16609,19 @@ "type": "number" }, "tax_codes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of tax codes.", "readonly": true, "type": "integer" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax.", "format": "currency", "indicator": true, @@ -10302,7 +16639,10 @@ "type": "array" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "format": "currency", "indicator": true, @@ -10310,13 +16650,19 @@ "type": "number" }, "tax_codes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of tax codes.", "readonly": true, "type": "integer" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax.", "format": "currency", "indicator": true, @@ -10335,51 +16681,80 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of variation items sold.", "indicator": true, "readonly": true, @@ -10387,42 +16762,68 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "segment_label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable segment label, either product or variation name.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of variation items sold.", "indicator": true, "readonly": true, @@ -10430,14 +16831,20 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -10463,11 +16870,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of variation items sold.", "indicator": true, "readonly": true, @@ -10475,42 +16888,68 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "segment_label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable segment label, either product or variation name.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of variation items sold.", "indicator": true, "readonly": true, @@ -10518,14 +16957,20 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -10553,75 +16998,119 @@ "properties": { "extended_info": { "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product attributes.", "readonly": true, "type": "array" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product image.", "readonly": true, "type": "string" }, "low_stock_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory threshold for low stock.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product link.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "stock_quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory quantity.", "readonly": true, "type": "integer" }, "stock_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory status.", "readonly": true, "type": "string" } }, "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of items sold.", "readonly": true, "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total Net sales of all items sold.", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders product appeared in.", "readonly": true, "type": "integer" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "integer" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "integer" @@ -10634,68 +17123,92 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "average_sales": { - "context": ["view"], + "context": [ + "view" + ], "description": "Average net daily sales.", "readonly": true, "type": "string" }, "net_sales": { - "context": ["view"], + "context": [ + "view" + ], "description": "Net sales in the period.", "readonly": true, "type": "string" }, "total_discount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total of coupons used.", "readonly": true, "type": "integer" }, "total_items": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total of items purchased.", "readonly": true, "type": "integer" }, "total_orders": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total of orders placed.", "readonly": true, "type": "integer" }, "total_refunds": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total of refunded orders.", "readonly": true, "type": "integer" }, "total_sales": { - "context": ["view"], + "context": [ + "view" + ], "description": "Gross sales in the period.", "readonly": true, "type": "string" }, "total_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total charged for shipping.", "readonly": true, "type": "string" }, "total_tax": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total charged for taxes.", "readonly": true, "type": "string" }, "totals": { - "context": ["view"], + "context": [ + "view" + ], "description": "Totals.", - "items": { "type": "array" }, + "items": { + "type": "array" + }, "readonly": true, "type": "array" }, "totals_grouped_by": { - "context": ["view"], + "context": [ + "view" + ], "description": "Group type.", "readonly": true, "type": "string" @@ -10708,33 +17221,63 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "Unique identifier for the object.", "readonly": true, - "type": ["integer", "string"] + "type": [ + "integer", + "string" + ] }, "subtype": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "Object subtype.", - "enum": ["post", "page", "product", "category", "post_tag", "product_cat", "product_tag"], + "enum": [ + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], "readonly": true, "type": "string" }, "title": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "The title for the object.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "Object type.", - "enum": ["post", "term", "post-format"], + "enum": [ + "post", + "post-format", + "term" + ], "readonly": true, "type": "string" }, "url": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "URL to the object.", "format": "uri", "readonly": true, @@ -10748,68 +17291,99 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "mixed" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.", "readonly": true, "type": "object" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea", "thumbnail_cropping" ], "readonly": true, "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Setting value.", "type": "mixed" } + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "mixed" + } }, "title": "setting", "type": "object" @@ -10818,31 +17392,41 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view"], + "context": [ + "view" + ], "description": "A unique identifier that can be used to link settings together.", "readonly": true, "type": "string" }, "label": { - "context": ["view"], + "context": [ + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "parent_id": { - "context": ["view"], + "context": [ + "view" + ], "description": "ID of parent grouping.", "readonly": true, "type": "string" }, "sub_groups": { - "context": ["view"], + "context": [ + "view" + ], "description": "IDs for settings sub groups.", "readonly": true, "type": "string" @@ -10869,14 +17453,20 @@ "default_comment_status": { "default": null, "description": "Allow people to submit comments on new posts.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "title": "Allow comments on new posts", "type": "string" }, "default_ping_status": { "default": null, "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "title": "", "type": "string" }, @@ -10886,7 +17476,12 @@ "title": "", "type": "string" }, - "description": { "default": null, "description": "Site tagline.", "title": "Tagline", "type": "string" }, + "description": { + "default": null, + "description": "Site tagline.", + "title": "Tagline", + "type": "string" + }, "email": { "default": null, "description": "This address is used for admin purposes, like new user notification.", @@ -10894,7 +17489,12 @@ "title": "", "type": "string" }, - "language": { "default": "en_US", "description": "WordPress locale code.", "title": "", "type": "string" }, + "language": { + "default": "en_US", + "description": "WordPress locale code.", + "title": "", + "type": "string" + }, "page_for_posts": { "default": null, "description": "The ID of the page that should display the latest posts", @@ -10912,15 +17512,24 @@ "default": [], "description": "WooCommerce Local Pickup Method Settings", "properties": { - "cost": { "description": "Optional cost to charge for local pickup.", "type": "string" }, + "cost": { + "description": "Optional cost to charge for local pickup.", + "type": "string" + }, "enabled": { "description": "If enabled, this method will appear on the block based checkout.", - "enum": ["yes", "no"], + "enum": [ + "no", + "yes" + ], "type": "string" }, "tax_status": { "description": "If a cost is defined, this controls if taxes are applied to that cost.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "title": { @@ -10940,17 +17549,33 @@ "address": { "additionalProperties": false, "properties": { - "address_1": { "type": "string" }, - "city": { "type": "string" }, - "country": { "type": "string" }, - "postcode": { "type": "string" }, - "state": { "type": "string" } + "address_1": { + "type": "string" + }, + "city": { + "type": "string" + }, + "country": { + "type": "string" + }, + "postcode": { + "type": "string" + }, + "state": { + "type": "string" + } }, "type": "object" }, - "details": { "type": "string" }, - "enabled": { "type": "boolean" }, - "name": { "type": "string" } + "details": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "name": { + "type": "string" + } }, "type": "object" }, @@ -10969,8 +17594,18 @@ "title": "Show on front", "type": "string" }, - "site_icon": { "default": null, "description": "Site icon.", "title": "Icon", "type": "integer" }, - "site_logo": { "default": null, "description": "Site logo.", "title": "Logo", "type": "integer" }, + "site_icon": { + "default": null, + "description": "Site icon.", + "title": "Icon", + "type": "integer" + }, + "site_logo": { + "default": null, + "description": "Site logo.", + "title": "Logo", + "type": "integer" + }, "start_of_week": { "default": null, "description": "A day number of the week that the week should start on.", @@ -10989,8 +17624,19 @@ "title": "", "type": "string" }, - "title": { "default": null, "description": "Site title.", "title": "Title", "type": "string" }, - "url": { "default": null, "description": "Site URL.", "format": "uri", "title": "", "type": "string" }, + "title": { + "default": null, + "description": "Site title.", + "title": "Title", + "type": "string" + }, + "url": { + "default": null, + "description": "Site URL.", + "format": "uri", + "title": "", + "type": "string" + }, "use_smilies": { "default": true, "description": "Convert emoticons like :-) and :-P to graphics on display.", @@ -11005,23 +17651,45 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "items": [ { - "anyOf": [{ "required": "layout_row" }, { "required": "layout_column" }], + "anyOf": [ + { + "required": "layout_row" + }, + { + "required": "layout_column" + } + ], "properties": { "available_layouts": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Available layouts -- single, dual, or both", - "items": { "enum": ["row", "column"], "type": "string" }, + "items": { + "enum": [ + "column", + "row" + ], + "type": "string" + }, "readonly": true, "type": "array" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Description", "readonly": true, "type": "string" }, "is_visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Suggestion visibility.", "readonly": true, "type": "boolean" @@ -11031,15 +17699,24 @@ "features": { "items": { "properties": { - "description": { "type": "string" }, - "icon": { "type": "string" }, - "title": { "type": "string" } + "description": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "title": { + "type": "string" + } }, "type": "object" }, "type": "array" }, - "image": { "description": "", "type": "string" } + "image": { + "description": "", + "type": "string" + } }, "type": "object" }, @@ -11048,39 +17725,61 @@ "features": { "items": { "properties": { - "description": { "type": "string" }, - "icon": { "type": "string" }, - "title": { "type": "string" } + "description": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "title": { + "type": "string" + } }, "type": "object" }, "type": "array" }, - "image": { "description": "", "type": "string" } + "image": { + "description": "", + "type": "string" + } }, "type": "object" }, "learn_more_link": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Learn more link .", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Plugin name.", "readonly": true, "required": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Plugin slug used in https:/wordpress.org/plugins/{slug}.", "readonly": true, "type": "string" } }, - "required": ["name", "is_visible", "available_layouts"], + "required": [ + "available_layouts", + "is_visible", + "name" + ], "type": "object" } ], @@ -11091,13 +17790,29 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "Shipping method description.", "readonly": true, "type": "string" }, - "id": { "context": ["view"], "description": "Method ID.", "readonly": true, "type": "string" }, - "title": { "context": ["view"], "description": "Shipping method title.", "readonly": true, "type": "string" } + "id": { + "context": [ + "view" + ], + "description": "Method ID.", + "readonly": true, + "type": "string" + }, + "title": { + "context": [ + "view" + ], + "description": "Shipping method title.", + "readonly": true, + "type": "string" + } }, "title": "shipping_method", "type": "object" @@ -11106,13 +17821,30 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Shipping zone name.", "type": "string" }, - "order": { "context": ["view", "edit"], "description": "Shipping zone order.", "type": "integer" } + "name": { + "context": [ + "edit", + "view" + ], + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Shipping zone order.", + "type": "integer" + } }, "title": "shipping_zone", "type": "object" @@ -11120,12 +17852,27 @@ "shipping_zone_location": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "code": { "context": ["view", "edit"], "description": "Shipping zone location code.", "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Shipping zone location code.", + "type": "string" + }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "country", "description": "Shipping zone location type.", - "enum": ["postcode", "state", "country", "continent"], + "enum": [ + "continent", + "country", + "postcode", + "state" + ], "type": "string" } }, @@ -11136,106 +17883,165 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "enabled": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method enabled status.", "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method instance ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method instance ID.", "readonly": true, "type": "integer" }, "method_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method description.", "readonly": true, "type": "string" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", "readonly": true, "type": "string" }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method title.", "readonly": true, "type": "string" }, - "order": { "context": ["view", "edit"], "description": "Shipping method sort order.", "type": "integer" }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method sort order.", + "type": "integer" + }, "settings": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", + "checkbox", "color", - "password", - "textarea", - "select", - "multiselect", - "radio", + "email", "image_width", - "checkbox" + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Setting value.", "type": "string" } + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } }, "type": "object" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method customer facing title.", "readonly": true, "type": "string" @@ -11248,160 +18054,290 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "context": ["view", "edit"], "description": "Coupon code.", "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": "string" + }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon was created, as GMT.", "readonly": true, "type": "date-time" }, "date_expires": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon expires, in the site's timezone.", "type": "date-time" }, "date_expires_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon expires, as GMT.", "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon was last modified, as GMT.", "readonly": true, "type": "date-time" }, - "description": { "context": ["view", "edit"], "description": "Coupon description.", "type": "string" }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Coupon description.", + "type": "string" + }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "type": "string" }, "email_restrictions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of email addresses that can use this coupon.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, "exclude_sale_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean" }, "excluded_product_categories": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of category IDs the coupon does not apply to.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "excluded_product_ids": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of product IDs the coupon cannot be used on.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "free_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the object.", "readonly": true, "type": "integer" }, "individual_use": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean" }, "limit_usage_to_x_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer" }, "maximum_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "minimum_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" }, "product_categories": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of category IDs the coupon applies to.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "product_ids": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of product IDs the coupon can be used on.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" }, "usage_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of times the coupon has been used already.", "readonly": true, "type": "integer" }, "usage_limit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How many times the coupon can be used in total.", "type": "integer" }, "usage_limit_per_user": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How many times the coupon can be used per customer.", "type": "integer" }, "used_by": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of user IDs (or guest email addresses) that have used the coupon.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "readonly": true, "type": "array" } @@ -11413,30 +18349,101 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "billing": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Billing address.", "properties": { - "address_1": { "context": ["view", "edit"], "description": "Address line 1", "type": "string" }, - "address_2": { "context": ["view", "edit"], "description": "Address line 2", "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company name.", "type": "string" }, + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name.", + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name.", + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone number.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "First name.", "type": "string" }, - "last_name": { "context": ["view", "edit"], "description": "Last name.", "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone number.", "type": "string" }, - "postcode": { "context": ["view", "edit"], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -11444,63 +18451,123 @@ "type": "object" }, "cart_hash": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "MD5 hash of basket items to ensure orders are not modified.", "readonly": true, "type": "string" }, "cart_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sum of line item taxes only.", "readonly": true, "type": "string" }, "coupon_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupons line data.", "items": { "properties": { - "code": { "context": ["view", "edit"], "description": "Coupon code.", "type": "mixed" }, - "discount": { "context": ["view", "edit"], "description": "Discount total.", "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": "mixed" + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -11511,13 +18578,19 @@ "type": "array" }, "created_via": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows where the order was created.", "readonly": true, "type": "string" }, "currency": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "EUR", "description": "Currency the order was created with, in ISO format.", "enum": [ @@ -11545,8 +18618,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -11688,139 +18761,244 @@ "type": "string" }, "customer_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 0, "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, "customer_ip_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Customer's IP address.", "readonly": true, "type": "string" }, "customer_note": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Note left by customer during checkout.", "type": "string" }, "customer_user_agent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "User agent of the customer.", "readonly": true, "type": "string" }, "date_completed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was completed, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_completed_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was completed, as GMT.", "readonly": true, "type": "date-time" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was created, as GMT.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was last modified, as GMT.", "readonly": true, "type": "date-time" }, "date_paid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was paid, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_paid_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was paid, as GMT.", "readonly": true, "type": "date-time" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount tax amount for the order.", "readonly": true, "type": "string" }, "discount_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount amount for the order.", "readonly": true, "type": "string" }, "fee_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee lines data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "name": { "context": ["view", "edit"], "description": "Fee name.", "type": "mixed" }, - "tax_class": { "context": ["view", "edit"], "description": "Tax class of fee.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": "mixed" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -11832,12 +19010,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -11848,30 +19032,60 @@ "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "is_editable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether an order can be edited.", "readonly": true, "type": "boolean" }, "line_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line items data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { - "id": { "context": ["view", "edit"], "description": "Image ID.", "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -11881,73 +19095,166 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "type": "mixed" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": "mixed" + }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, - "product_id": { "context": ["view", "edit"], "description": "Product ID.", "type": "mixed" }, - "quantity": { "context": ["view", "edit"], "description": "Quantity ordered.", "type": "integer" }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": "mixed" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, - "tax_class": { "context": ["view", "edit"], "description": "Tax class of product.", "type": "string" }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Tax rate ID", "type": "integer" }, - "subtotal": { "context": ["view", "edit"], "description": "Tax subtotal.", "type": "string" }, - "total": { "context": ["view", "edit"], "description": "Tax total.", "type": "string" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "type": "string" + } }, "type": "object" }, @@ -11955,18 +19262,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -11976,65 +19292,152 @@ "type": "array" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "needs_payment": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether an order needs payment, based on status and order total.", "readonly": true, "type": "boolean" }, "needs_processing": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether an order needs processing before it can be completed.", "readonly": true, "type": "boolean" }, - "number": { "context": ["view", "edit"], "description": "Order number.", "readonly": true, "type": "string" }, - "order_key": { "context": ["view", "edit"], "description": "Order key.", "readonly": true, "type": "string" }, - "parent_id": { "context": ["view", "edit"], "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "context": ["view", "edit"], "description": "Payment method ID.", "type": "string" }, + "number": { + "context": [ + "edit", + "view" + ], + "description": "Order number.", + "readonly": true, + "type": "string" + }, + "order_key": { + "context": [ + "edit", + "view" + ], + "description": "Order key.", + "readonly": true, + "type": "string" + }, + "parent_id": { + "context": [ + "edit", + "view" + ], + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "context": [ + "edit", + "view" + ], + "description": "Payment method ID.", + "type": "string" + }, "payment_method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment method title.", "type": "string" }, "payment_url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order payment URL.", "readonly": true, "type": "string" }, "prices_include_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True the prices included tax during checkout.", "readonly": true, "type": "boolean" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of refunds.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Refund ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Refund ID.", + "readonly": true, + "type": "integer" + }, "reason": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Refund reason.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Refund total.", "readonly": true, "type": "string" @@ -12046,29 +19449,89 @@ "type": "array" }, "set_paid": { - "context": ["edit"], + "context": [ + "edit" + ], "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping address.", "properties": { - "address_1": { "context": ["view", "edit"], "description": "Address line 1", "type": "string" }, - "address_2": { "context": ["view", "edit"], "description": "Address line 2", "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company name.", "type": "string" }, + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "First name.", "type": "string" }, - "last_name": { "context": ["view", "edit"], "description": "Last name.", "type": "string" }, - "postcode": { "context": ["view", "edit"], "description": "Postal code.", "type": "string" }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name.", + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" + }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -12076,53 +19539,106 @@ "type": "object" }, "shipping_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping lines data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "method_id": { "context": ["view", "edit"], "description": "Shipping method ID.", "type": "mixed" }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": "mixed" + }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", "type": "mixed" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -12134,12 +19650,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -12150,90 +19672,148 @@ "type": "array" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total shipping tax amount for the order.", "readonly": true, "type": "string" }, "shipping_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total shipping amount for the order.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "pending", "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "type": "string" }, "tax_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax lines data.", "items": { "properties": { "compound": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Show if is a compound tax rate.", "readonly": true, "type": "boolean" }, - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate label.", "readonly": true, "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "rate_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate code.", "readonly": true, "type": "string" }, "rate_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "shipping_tax_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax total.", "readonly": true, "type": "string" }, "tax_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total (not including shipping taxes).", "readonly": true, "type": "string" @@ -12244,16 +19824,37 @@ "readonly": true, "type": "array" }, - "total": { "context": ["view", "edit"], "description": "Grand total.", "readonly": true, "type": "string" }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Grand total.", + "readonly": true, + "type": "string" + }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sum of all taxes.", "readonly": true, "type": "string" }, - "transaction_id": { "context": ["view", "edit"], "description": "Unique transaction ID.", "type": "string" }, + "transaction_id": { + "context": [ + "edit", + "view" + ], + "description": "Unique transaction ID.", + "type": "string" + }, "version": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Version of WooCommerce which last updated the order.", "readonly": true, "type": "string" @@ -12265,76 +19866,154 @@ "shop_order_refund": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "amount": { "context": ["view", "edit"], "description": "Refund amount.", "type": "string" }, + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Refund amount.", + "type": "string" + }, "api_refund": { - "context": ["edit"], + "context": [ + "edit" + ], "default": true, "description": "When true, the payment gateway API is used to generate the refund.", "type": "boolean" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order refund was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order refund was created, as GMT.", "readonly": true, "type": "date-time" }, "fee_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee lines data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "name": { "context": ["view", "edit"], "description": "Fee name.", "type": "mixed" }, - "tax_class": { "context": ["view", "edit"], "description": "Tax class of fee.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": "mixed" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -12346,12 +20025,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -12362,36 +20047,62 @@ "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "line_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line items data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", "readonly": true, "type": "mixed" @@ -12403,72 +20114,108 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, "type": "mixed" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "mixed" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "readonly": true, "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "readonly": true, "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "readonly": true, "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -12480,19 +20227,28 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "readonly": true, "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "readonly": true, "type": "integer" @@ -12504,78 +20260,169 @@ "type": "array" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "reason": { "context": ["view", "edit"], "description": "Reason for refund.", "type": "string" }, + "reason": { + "context": [ + "edit", + "view" + ], + "description": "Reason for refund.", + "type": "string" + }, "refunded_by": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "User ID of user who created the refund.", "type": "integer" }, "refunded_payment": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If the payment was refunded via the API.", "readonly": true, "type": "boolean" }, "shipping_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping lines data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "method_id": { "context": ["view", "edit"], "description": "Shipping method ID.", "type": "mixed" }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": "mixed" + }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", "type": "mixed" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -12587,12 +20434,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -12603,61 +20456,110 @@ "type": "array" }, "tax_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax lines data.", "items": { "properties": { "compound": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Show if is a compound tax rate.", "readonly": true, "type": "boolean" }, - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate label.", "readonly": true, "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "rate_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate code.", "readonly": true, "type": "string" }, "rate_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "shipping_tax_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax total.", "readonly": true, "type": "string" }, "tax_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total (not including shipping taxes).", "readonly": true, "type": "string" @@ -12676,69 +20578,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "after_title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "HTML content to append to the sidebar title when displayed. Default is a closing h2 element.", "readonly": true, "type": "string" }, "after_widget": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.", "readonly": true, "type": "string" }, "before_title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.", "readonly": true, "type": "string" }, "before_widget": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.", "readonly": true, "type": "string" }, "class": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Extra CSS class to assign to the sidebar in the Widgets interface.", "readonly": true, "type": "string" }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Description of sidebar.", "readonly": true, "type": "string" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of sidebar.", "readonly": true, "type": "string" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique name identifying the sidebar.", "readonly": true, "type": "string" }, "status": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Status of sidebar.", - "enum": ["active", "inactive"], + "enum": [ + "active", + "inactive" + ], "readonly": true, "type": "string" }, "widgets": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Nested widgets.", - "items": { "type": ["object", "string"] }, + "items": { + "type": [ + "object", + "string" + ] + }, "type": "array" } }, @@ -12749,49 +20699,72 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date_floating": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether posts of this status may have floating published dates.", "readonly": true, "type": "boolean" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the status.", "readonly": true, "type": "string" }, "private": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether posts with this status should be private.", "readonly": true, "type": "boolean" }, "protected": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether posts with this status should be protected.", "readonly": true, "type": "boolean" }, "public": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether posts of this status should be shown in the front end of the site.", "readonly": true, "type": "boolean" }, "queryable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether posts with this status should be publicly-queryable.", "readonly": true, "type": "boolean" }, "show_in_list": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether to include posts in the edit listing for their post type.", "readonly": true, "type": "boolean" }, "slug": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the status.", "readonly": true, "type": "string" @@ -12804,37 +20777,53 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "active_plugins": { - "context": ["view"], + "context": [ + "view" + ], "description": "Active plugins.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "database": { - "context": ["view"], + "context": [ + "view" + ], "description": "Database.", "properties": { "database_prefix": { - "context": ["view"], + "context": [ + "view" + ], "description": "Database prefix.", "readonly": true, "type": "string" }, "database_tables": { - "context": ["view"], + "context": [ + "view" + ], "description": "Database tables.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "maxmind_geoip_database": { - "context": ["view"], + "context": [ + "view" + ], "description": "MaxMind GeoIP database.", "readonly": true, "type": "string" }, "wc_database_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "WC database version.", "readonly": true, "type": "string" @@ -12844,196 +20833,276 @@ "type": "object" }, "dropins_mu_plugins": { - "context": ["view"], + "context": [ + "view" + ], "description": "Dropins & MU plugins.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "environment": { - "context": ["view"], + "context": [ + "view" + ], "description": "Environment.", "properties": { "curl_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "cURL version.", "readonly": true, "type": "string" }, "default_timezone": { - "context": ["view"], + "context": [ + "view" + ], "description": "Default timezone.", "readonly": true, "type": "string" }, "domdocument_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is DomDocument class enabled?", "readonly": true, "type": "boolean" }, "fsockopen_or_curl_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is fsockopen/cURL enabled?", "readonly": true, "type": "boolean" }, "gzip_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is GZip enabled?", "readonly": true, "type": "boolean" }, "home_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Home URL.", "format": "uri", "readonly": true, "type": "string" }, "language": { - "context": ["view"], + "context": [ + "view" + ], "description": "WordPress language.", "readonly": true, "type": "string" }, "log_directory": { - "context": ["view"], + "context": [ + "view" + ], "description": "Log directory.", "readonly": true, "type": "string" }, "log_directory_writable": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is log directory writable?", "readonly": true, "type": "boolean" }, "max_upload_size": { - "context": ["view"], + "context": [ + "view" + ], "description": "Max upload size.", "readonly": true, "type": "integer" }, "mbstring_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is mbstring enabled?", "readonly": true, "type": "boolean" }, "mysql_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "MySQL version.", "readonly": true, "type": "string" }, "mysql_version_string": { - "context": ["view"], + "context": [ + "view" + ], "description": "MySQL version string.", "readonly": true, "type": "string" }, "php_max_execution_time": { - "context": ["view"], + "context": [ + "view" + ], "description": "PHP max execution time.", "readonly": true, "type": "integer" }, "php_max_input_vars": { - "context": ["view"], + "context": [ + "view" + ], "description": "PHP max input vars.", "readonly": true, "type": "integer" }, "php_post_max_size": { - "context": ["view"], + "context": [ + "view" + ], "description": "PHP post max size.", "readonly": true, "type": "integer" }, - "php_version": { "context": ["view"], "description": "PHP version.", "readonly": true, "type": "string" }, + "php_version": { + "context": [ + "view" + ], + "description": "PHP version.", + "readonly": true, + "type": "string" + }, "remote_get_response": { - "context": ["view"], + "context": [ + "view" + ], "description": "Remote GET response.", "readonly": true, "type": "string" }, "remote_get_successful": { - "context": ["view"], + "context": [ + "view" + ], "description": "Remote GET successful?", "readonly": true, "type": "boolean" }, "remote_post_response": { - "context": ["view"], + "context": [ + "view" + ], "description": "Remote POST response.", "readonly": true, "type": "string" }, "remote_post_successful": { - "context": ["view"], + "context": [ + "view" + ], "description": "Remote POST successful?", "readonly": true, "type": "boolean" }, - "server_info": { "context": ["view"], "description": "Server info.", "readonly": true, "type": "string" }, + "server_info": { + "context": [ + "view" + ], + "description": "Server info.", + "readonly": true, + "type": "string" + }, "site_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Site URL.", "format": "uri", "readonly": true, "type": "string" }, "soapclient_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is SoapClient class enabled?", "readonly": true, "type": "boolean" }, "store_id": { - "context": ["view"], + "context": [ + "view" + ], "description": "WooCommerce Store Identifier.", "readonly": true, "type": "string" }, "suhosin_installed": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is SUHOSIN installed?", "readonly": true, "type": "boolean" }, "version": { - "context": ["view"], + "context": [ + "view" + ], "description": "WooCommerce version.", "readonly": true, "type": "string" }, "wp_cron": { - "context": ["view"], + "context": [ + "view" + ], "description": "Are WordPress cron jobs enabled?", "readonly": true, "type": "boolean" }, "wp_debug_mode": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is WordPress debug mode active?", "readonly": true, "type": "boolean" }, "wp_memory_limit": { - "context": ["view"], + "context": [ + "view" + ], "description": "WordPress memory limit.", "readonly": true, "type": "integer" }, "wp_multisite": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is WordPress multisite?", "readonly": true, "type": "boolean" }, "wp_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "WordPress version.", "readonly": true, "type": "string" @@ -13043,42 +21112,58 @@ "type": "object" }, "inactive_plugins": { - "context": ["view"], + "context": [ + "view" + ], "description": "Inactive plugins.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "logging": { - "context": ["view"], + "context": [ + "view" + ], "description": "Logging.", "properties": { "default_handler": { - "context": ["view"], + "context": [ + "view" + ], "description": "The logging handler class.", "readonly": true, "type": "string" }, "level_threshold": { - "context": ["view"], + "context": [ + "view" + ], "description": "Minimum severity level.", "readonly": true, "type": "string" }, "log_directory_size": { - "context": ["view"], + "context": [ + "view" + ], "description": "The size of the log directory.", "readonly": true, "type": "string" }, "logging_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is logging enabled?", "readonly": true, "type": "boolean" }, "retention_period_days": { - "context": ["view"], + "context": [ + "view" + ], "description": "The number of days log entries are retained.", "readonly": true, "type": "integer" @@ -13088,31 +21173,45 @@ "type": "object" }, "pages": { - "context": ["view"], + "context": [ + "view" + ], "description": "WooCommerce pages.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "post_type_counts": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total post count.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "security": { - "context": ["view"], + "context": [ + "view" + ], "description": "Security.", "properties": { "hide_errors": { - "context": ["view"], + "context": [ + "view" + ], "description": "Hide errors from visitors?", "readonly": true, "type": "boolean" }, "secure_connection": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is the connection to your store secure?", "readonly": true, "type": "boolean" @@ -13122,93 +21221,141 @@ "type": "object" }, "settings": { - "context": ["view"], + "context": [ + "view" + ], "description": "Settings.", "properties": { "HPOS_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is HPOS enabled?", "readonly": true, "type": "boolean" }, "HPOS_sync_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is HPOS sync enabled?", "readonly": true, "type": "boolean" }, "api_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Legacy REST API enabled?", "readonly": true, "type": "boolean" }, - "currency": { "context": ["view"], "description": "Currency.", "readonly": true, "type": "string" }, + "currency": { + "context": [ + "view" + ], + "description": "Currency.", + "readonly": true, + "type": "string" + }, "currency_position": { - "context": ["view"], + "context": [ + "view" + ], "description": "Currency position.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view"], + "context": [ + "view" + ], "description": "Currency symbol.", "readonly": true, "type": "string" }, "decimal_separator": { - "context": ["view"], + "context": [ + "view" + ], "description": "Decimal separator.", "readonly": true, "type": "string" }, "enforce_approved_download_dirs": { - "context": ["view"], + "context": [ + "view" + ], "description": "Enforce approved download directories?", "readonly": true, "type": "boolean" }, - "force_ssl": { "context": ["view"], "description": "SSL forced?", "readonly": true, "type": "boolean" }, + "force_ssl": { + "context": [ + "view" + ], + "description": "SSL forced?", + "readonly": true, + "type": "boolean" + }, "geolocation_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Geolocation enabled?", "readonly": true, "type": "boolean" }, "number_of_decimals": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of decimals.", "readonly": true, "type": "integer" }, "order_datastore": { - "context": ["view"], + "context": [ + "view" + ], "description": "Order datastore.", "readonly": true, "type": "string" }, "product_visibility_terms": { - "context": ["view"], + "context": [ + "view" + ], "description": "Terms in the product visibility taxonomy.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "taxonomies": { - "context": ["view"], + "context": [ + "view" + ], "description": "Taxonomy terms for product/order statuses.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "thousand_separator": { - "context": ["view"], + "context": [ + "view" + ], "description": "Thousand separator.", "readonly": true, "type": "string" }, "wccom_connected": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is store connected to WooCommerce.com?", "readonly": true, "type": "string" @@ -13218,70 +21365,108 @@ "type": "object" }, "theme": { - "context": ["view"], + "context": [ + "view" + ], "description": "Theme.", "properties": { "author_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Theme author URL.", "format": "uri", "readonly": true, "type": "string" }, "has_outdated_templates": { - "context": ["view"], + "context": [ + "view" + ], "description": "Does this theme have outdated templates?", "readonly": true, "type": "boolean" }, "has_woocommerce_file": { - "context": ["view"], + "context": [ + "view" + ], "description": "Does the theme have a woocommerce.php file?", "readonly": true, "type": "boolean" }, "has_woocommerce_support": { - "context": ["view"], + "context": [ + "view" + ], "description": "Does the theme declare WooCommerce support?", "readonly": true, "type": "boolean" }, "is_child_theme": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is this theme a child theme?", "readonly": true, "type": "boolean" }, - "name": { "context": ["view"], "description": "Theme name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Theme name.", + "readonly": true, + "type": "string" + }, "overrides": { - "context": ["view"], + "context": [ + "view" + ], "description": "Template overrides.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "parent_author_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Parent theme author URL.", "format": "uri", "readonly": true, "type": "string" }, "parent_name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Parent theme name.", "readonly": true, "type": "string" }, "parent_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "Parent theme version.", "readonly": true, "type": "string" }, - "version": { "context": ["view"], "description": "Theme version.", "readonly": true, "type": "string" }, + "version": { + "context": [ + "view" + ], + "description": "Theme version.", + "readonly": true, + "type": "string" + }, "version_latest": { - "context": ["view"], + "context": [ + "view" + ], "description": "Latest version of theme.", "readonly": true, "type": "string" @@ -13297,12 +21482,52 @@ "system_status_tool": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "action": { "context": ["view", "edit"], "description": "What running the tool will do.", "type": "string" }, - "description": { "context": ["view", "edit"], "description": "Tool description.", "type": "string" }, - "id": { "context": ["view", "edit"], "description": "A unique identifier for the tool.", "type": "string" }, - "message": { "context": ["edit"], "description": "Tool return message.", "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Tool name.", "type": "string" }, - "success": { "context": ["edit"], "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "context": [ + "edit", + "view" + ], + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Tool description.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the tool.", + "type": "string" + }, + "message": { + "context": [ + "edit" + ], + "description": "Tool return message.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tool name.", + "type": "string" + }, + "success": { + "context": [ + "edit" + ], + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "title": "system_status_tool", "type": "object" @@ -13311,45 +21536,81 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["post_tag"], + "enum": [ + "post_tag" + ], "readonly": true, "type": "string" } @@ -13360,43 +21621,112 @@ "tax": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, "class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "standard", "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "type": "string" }, "compound": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "context": ["view", "edit"], "description": "Country ISO 3166 code.", "type": "string" }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country ISO 3166 code.", + "type": "string" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Tax rate name.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate name.", + "type": "string" + }, "order": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "context": ["view", "edit"], "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "context": ["view", "edit"], "default": 1, "description": "Tax priority.", "type": "integer" }, - "rate": { "context": ["view", "edit"], "description": "Tax rate.", "type": "string" }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "context": [ + "edit", + "view" + ], + "default": 1, + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate.", + "type": "string" + }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "context": ["view", "edit"], "description": "State code.", "type": "string" } + "state": { + "context": [ + "edit", + "view" + ], + "description": "State code.", + "type": "string" + } }, "title": "tax", "type": "object" @@ -13404,9 +21734,20 @@ "tax_class": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view", "edit"], "description": "Tax class name.", "required": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax class name.", + "required": true, + "type": "string" + }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "string" @@ -13419,75 +21760,113 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "capabilities": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "All capabilities used by the taxonomy.", "readonly": true, "type": "object" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human-readable description of the taxonomy.", "readonly": true, "type": "string" }, "hierarchical": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the taxonomy should have children.", "readonly": true, "type": "boolean" }, "labels": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Human-readable labels for the taxonomy for various contexts.", "readonly": true, "type": "object" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the taxonomy.", "readonly": true, "type": "string" }, "rest_base": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "REST base route for the taxonomy.", "readonly": true, "type": "string" }, "rest_namespace": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "REST namespace route for the taxonomy.", "readonly": true, "type": "string" }, "show_cloud": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether or not the term cloud should be displayed.", "readonly": true, "type": "boolean" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the taxonomy.", "readonly": true, "type": "string" }, "types": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Types associated with the taxonomy.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "visibility": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "The visibility settings for the taxonomy.", "properties": { "public": { "description": "Whether a taxonomy is intended for use publicly either via the admin interface or by front end users.", "type": "boolean" }, - "publicly_queryable": { "description": "Whether the taxonomy is publicly queryable.", "type": "boolean" }, + "publicly_queryable": { + "description": "Whether the taxonomy is publicly queryable.", + "type": "boolean" + }, "show_admin_column": { "description": "Whether to allow automatic creation of taxonomy columns on associated post types table.", "type": "boolean" @@ -13516,32 +21895,55 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of objects (posts of any type) assigned to the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Term description.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Term name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "readonly": true, + "type": "string" + }, "parent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent term ID, if applicable.", "readonly": true, "type": "integer" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "String based identifier for the term.", "readonly": true, "type": "string" @@ -13556,8 +21958,14 @@ "author": { "description": "The theme author.", "properties": { - "raw": { "description": "The theme author's name, as found in the theme header.", "type": "string" }, - "rendered": { "description": "HTML for the theme author, transformed for display.", "type": "string" } + "raw": { + "description": "The theme author's name, as found in the theme header.", + "type": "string" + }, + "rendered": { + "description": "HTML for the theme author, transformed for display.", + "type": "string" + } }, "readonly": true, "type": "object" @@ -13582,8 +21990,14 @@ "description": { "description": "A description of the theme.", "properties": { - "raw": { "description": "The theme description, as found in the theme header.", "type": "string" }, - "rendered": { "description": "The theme description, transformed for display.", "type": "string" } + "raw": { + "description": "The theme description, as found in the theme header.", + "type": "string" + }, + "rendered": { + "description": "The theme description, transformed for display.", + "type": "string" + } }, "readonly": true, "type": "object" @@ -13596,8 +22010,14 @@ "name": { "description": "The name of the theme.", "properties": { - "raw": { "description": "The theme name, as found in the theme header.", "type": "string" }, - "rendered": { "description": "The theme name, transformed for display.", "type": "string" } + "raw": { + "description": "The theme name, as found in the theme header.", + "type": "string" + }, + "rendered": { + "description": "The theme name, transformed for display.", + "type": "string" + } }, "readonly": true, "type": "object" @@ -13620,7 +22040,10 @@ }, "status": { "description": "A named status for the theme.", - "enum": ["inactive", "active"], + "enum": [ + "active", + "inactive" + ], "type": "string" }, "stylesheet": { @@ -13639,10 +22062,15 @@ "properties": { "raw": { "description": "The theme tags, as found in the theme header.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, - "rendered": { "description": "The theme tags, transformed for display.", "type": "string" } + "rendered": { + "description": "The theme tags, transformed for display.", + "type": "string" + } }, "readonly": true, "type": "object" @@ -13658,7 +22086,11 @@ "readonly": true, "type": "string" }, - "textdomain": { "description": "The theme's text domain.", "readonly": true, "type": "string" }, + "textdomain": { + "description": "The theme's text domain.", + "readonly": true, + "type": "string" + }, "theme_supports": { "description": "Features supported by this theme.", "properties": { @@ -13687,48 +22119,142 @@ "default": false, "description": "Custom background if defined by the theme.", "properties": { - "default-attachment": { "enum": ["scroll", "fixed"], "type": "string" }, - "default-color": { "type": "string" }, - "default-image": { "format": "uri", "type": "string" }, - "default-position-x": { "enum": ["left", "center", "right"], "type": "string" }, - "default-position-y": { "enum": ["left", "center", "right"], "type": "string" }, - "default-preset": { "enum": ["default", "fill", "fit", "repeat", "custom"], "type": "string" }, - "default-repeat": { "enum": ["repeat-x", "repeat-y", "repeat", "no-repeat"], "type": "string" }, - "default-size": { "enum": ["auto", "contain", "cover"], "type": "string" } + "default-attachment": { + "enum": [ + "fixed", + "scroll" + ], + "type": "string" + }, + "default-color": { + "type": "string" + }, + "default-image": { + "format": "uri", + "type": "string" + }, + "default-position-x": { + "enum": [ + "center", + "left", + "right" + ], + "type": "string" + }, + "default-position-y": { + "enum": [ + "center", + "left", + "right" + ], + "type": "string" + }, + "default-preset": { + "enum": [ + "custom", + "default", + "fill", + "fit", + "repeat" + ], + "type": "string" + }, + "default-repeat": { + "enum": [ + "no-repeat", + "repeat", + "repeat-x", + "repeat-y" + ], + "type": "string" + }, + "default-size": { + "enum": [ + "auto", + "contain", + "cover" + ], + "type": "string" + } }, - "type": ["boolean", "object"] + "type": [ + "boolean", + "object" + ] }, "custom-header": { "additionalProperties": false, "default": false, "description": "Custom header if defined by the theme.", "properties": { - "default-image": { "format": "uri", "type": "string" }, - "default-text-color": { "type": "string" }, - "flex-height": { "type": "boolean" }, - "flex-width": { "type": "boolean" }, - "header-text": { "type": "boolean" }, - "height": { "type": "integer" }, - "random-default": { "type": "boolean" }, - "uploads": { "type": "boolean" }, - "video": { "type": "boolean" }, - "width": { "type": "integer" } + "default-image": { + "format": "uri", + "type": "string" + }, + "default-text-color": { + "type": "string" + }, + "flex-height": { + "type": "boolean" + }, + "flex-width": { + "type": "boolean" + }, + "header-text": { + "type": "boolean" + }, + "height": { + "type": "integer" + }, + "random-default": { + "type": "boolean" + }, + "uploads": { + "type": "boolean" + }, + "video": { + "type": "boolean" + }, + "width": { + "type": "integer" + } }, - "type": ["boolean", "object"] + "type": [ + "boolean", + "object" + ] }, "custom-logo": { "additionalProperties": false, "default": false, "description": "Custom logo if defined by the theme.", "properties": { - "flex-height": { "type": "boolean" }, - "flex-width": { "type": "boolean" }, - "header-text": { "items": { "type": "string" }, "type": "array" }, - "height": { "type": "integer" }, - "unlink-homepage-logo": { "type": "boolean" }, - "width": { "type": "integer" } + "flex-height": { + "type": "boolean" + }, + "flex-width": { + "type": "boolean" + }, + "header-text": { + "items": { + "type": "string" + }, + "type": "array" + }, + "height": { + "type": "integer" + }, + "unlink-homepage-logo": { + "type": "boolean" + }, + "width": { + "type": "integer" + } }, - "type": ["boolean", "object"] + "type": [ + "boolean", + "object" + ] }, "customize-selective-refresh-widgets": { "default": false, @@ -13766,13 +22292,22 @@ "items": { "additionalProperties": false, "properties": { - "color": { "type": "string" }, - "name": { "type": "string" }, - "slug": { "type": "string" } + "color": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + } }, "type": "object" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "editor-font-sizes": { "default": false, @@ -13780,13 +22315,22 @@ "items": { "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "size": { "type": "number" }, - "slug": { "type": "string" } + "name": { + "type": "string" + }, + "size": { + "type": "number" + }, + "slug": { + "type": "string" + } }, "type": "object" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "editor-gradient-presets": { "default": false, @@ -13794,13 +22338,22 @@ "items": { "additionalProperties": false, "properties": { - "gradient": { "type": "string" }, - "name": { "type": "string" }, - "slug": { "type": "string" } + "gradient": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + } }, "type": "object" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "editor-spacing-sizes": { "default": false, @@ -13808,13 +22361,22 @@ "items": { "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "size": { "type": "string" }, - "slug": { "type": "string" } + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "slug": { + "type": "string" + } }, "type": "object" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "editor-styles": { "default": false, @@ -13822,7 +22384,9 @@ "type": "boolean" }, "formats": { - "default": ["standard"], + "default": [ + "standard" + ], "description": "Post formats supported.", "items": { "enum": { @@ -13845,16 +22409,32 @@ "default": false, "description": "Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.", "items": { - "enum": ["search-form", "comment-form", "comment-list", "gallery", "caption", "script", "style"], + "enum": [ + "caption", + "comment-form", + "comment-list", + "gallery", + "script", + "search-form", + "style" + ], "type": "string" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "post-thumbnails": { "default": false, "description": "The post types that support thumbnails or true if all post types are supported.", - "items": { "type": "string" }, - "type": ["boolean", "array"] + "items": { + "type": "string" + }, + "type": [ + "array", + "boolean" + ] }, "responsive-embeds": { "default": false, @@ -13892,7 +22472,11 @@ "readonly": true, "type": "object" }, - "version": { "description": "The theme's current version.", "readonly": true, "type": "string" } + "version": { + "description": "The theme's current version.", + "readonly": true, + "type": "string" + } }, "title": "theme", "type": "object" @@ -13900,10 +22484,26 @@ "top_sellers_report": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Product name.", "readonly": true, "type": "string" }, - "product_id": { "context": ["view"], "description": "Product ID.", "readonly": true, "type": "integer" }, + "name": { + "context": [ + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "product_id": { + "context": [ + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + }, "quantity": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total number of purchases.", "readonly": true, "type": "integer" @@ -13916,99 +22516,167 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "capabilities": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "All capabilities used by the post type.", "readonly": true, "type": "object" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human-readable description of the post type.", "readonly": true, "type": "string" }, "has_archive": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive.", "readonly": true, - "type": ["string", "boolean"] + "type": [ + "boolean", + "string" + ] }, "hierarchical": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post type should have children.", "readonly": true, "type": "boolean" }, "icon": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The icon for the post type.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "labels": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Human-readable labels for the post type for various contexts.", "readonly": true, "type": "object" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post type.", "readonly": true, "type": "string" }, "rest_base": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "REST base route for the post type.", "readonly": true, "type": "string" }, "rest_namespace": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "REST route's namespace for the post type.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post type.", "readonly": true, "type": "string" }, "supports": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "All features, supported by the post type.", "readonly": true, "type": "object" }, "taxonomies": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxonomies associated with post type.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "template": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The block template associated with the post type.", "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "template_lock": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The template_lock associated with the post type, or false if none.", - "enum": ["all", "insert", "contentOnly", false], + "enum": [ + "all", + "insert", + "contentOnly", + false + ], "readonly": true, - "type": ["string", "boolean"] + "type": [ + "boolean", + "string" + ] }, "viewable": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether or not the post type can be viewed.", "readonly": true, "type": "boolean" }, "visibility": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "The visibility settings for the post type.", "properties": { "show_in_nav_menus": { @@ -14031,18 +22699,32 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Theme installation message.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Theme installation status.", "readonly": true, "type": "string" }, - "theme": { "context": ["view", "edit"], "description": "Uploaded theme.", "readonly": true, "type": "object" } + "theme": { + "context": [ + "edit", + "view" + ], + "description": "Uploaded theme.", + "readonly": true, + "type": "object" + } }, "title": "upload_theme", "type": "object" @@ -14051,23 +22733,39 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "avatar_urls": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URLs for the user.", "properties": { "24": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 24 pixels.", "format": "uri", "type": "string" }, "48": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 48 pixels.", "format": "uri", "type": "string" }, "96": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 96 pixels.", "format": "uri", "type": "string" @@ -14077,57 +22775,100 @@ "type": "object" }, "capabilities": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "All capabilities assigned to the user.", "readonly": true, "type": "object" }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Description of the user.", "type": "string" }, "email": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "The email address for the user.", "format": "email", "required": true, "type": "string" }, "extra_capabilities": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Any extra capabilities assigned to the user.", "readonly": true, "type": "object" }, - "first_name": { "context": ["edit"], "description": "First name for the user.", "type": "string" }, + "first_name": { + "context": [ + "edit" + ], + "description": "First name for the user.", + "type": "string" + }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the user.", "readonly": true, "type": "integer" }, - "last_name": { "context": ["edit"], "description": "Last name for the user.", "type": "string" }, + "last_name": { + "context": [ + "edit" + ], + "description": "Last name for the user.", + "type": "string" + }, "link": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Author URL of the user.", "format": "uri", "readonly": true, "type": "string" }, "locale": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Locale for the user.", - "enum": ["", "en_US", "en_GB", "fr_BE", "fr_FR"], + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], "type": "string" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", "properties": { "persisted_preferences": { "additionalProperties": true, - "context": ["edit"], + "context": [ + "edit" + ], "default": [], "description": "", "properties": { @@ -14154,11 +22895,21 @@ "type": "object" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Display name for the user.", "type": "string" }, - "nickname": { "context": ["edit"], "description": "The nickname for the user.", "type": "string" }, + "nickname": { + "context": [ + "edit" + ], + "description": "The nickname for the user.", + "type": "string" + }, "password": { "context": [], "description": "Password for the user (never included).", @@ -14166,31 +22917,47 @@ "type": "string" }, "registered_date": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Registration date for the user.", "format": "date-time", "readonly": true, "type": "string" }, "roles": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Roles assigned to the user.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, "slug": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the user.", "type": "string" }, "url": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the user.", "format": "uri", "type": "string" }, "username": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Login name for the user.", "required": true, "type": "string" @@ -14203,70 +22970,127 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook was created, as GMT.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook was last modified, as GMT.", "readonly": true, "type": "date-time" }, "delivery_url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The URL where the webhook payload is delivered.", "format": "uri", "readonly": true, "type": "string" }, - "event": { "context": ["view", "edit"], "description": "Webhook event.", "readonly": true, "type": "string" }, + "event": { + "context": [ + "edit", + "view" + ], + "description": "Webhook event.", + "readonly": true, + "type": "string" + }, "hooks": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "WooCommerce action names associated with the webhook.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "A friendly name for the webhook.", + "type": "string" + }, "resource": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Webhook resource.", "readonly": true, "type": "string" }, "secret": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "active", "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "type": "string" }, - "topic": { "context": ["view", "edit"], "description": "Webhook topic.", "type": "string" } + "topic": { + "context": [ + "edit", + "view" + ], + "description": "Webhook topic.", + "type": "string" + } }, "title": "webhook", "type": "object" @@ -14275,71 +23099,106 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook delivery was logged, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook delivery was logged, as GMT.", "readonly": true, "type": "date-time" }, "duration": { - "context": ["view"], + "context": [ + "view" + ], "description": "The delivery duration, in seconds.", "readonly": true, "type": "string" }, "id": { - "context": ["view"], + "context": [ + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "request_body": { "context": ["view"], "description": "Request body", "readonly": true, "type": "string" }, + "request_body": { + "context": [ + "view" + ], + "description": "Request body", + "readonly": true, + "type": "string" + }, "request_headers": { - "context": ["view"], + "context": [ + "view" + ], "description": "Request headers", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "request_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "The URL where the webhook was delivered.", "format": "uri", "readonly": true, "type": "string" }, "response_body": { - "context": ["view"], + "context": [ + "view" + ], "description": "The response body from the receiving server.", "readonly": true, "type": "string" }, "response_code": { - "context": ["view"], + "context": [ + "view" + ], "description": "The HTTP response code from the receiving server.", "readonly": true, "type": "string" }, "response_headers": { - "context": ["view"], + "context": [ + "view" + ], "description": "Array of the response headers from the receiving server.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "response_message": { - "context": ["view"], + "context": [ + "view" + ], "description": "The HTTP response message from the receiving server.", "readonly": true, "type": "string" }, "summary": { - "context": ["view"], + "context": [ + "view" + ], "description": "A friendly summary of the response including the HTTP response code, message, and body.", "readonly": true, "type": "string" @@ -14357,32 +23216,48 @@ "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the widget.", "type": "string" }, "id_base": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, "instance": { - "context": ["edit"], + "context": [ + "edit" + ], "default": null, "description": "Instance settings of the widget, if supported.", "properties": { "encoded": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Base64 encoded representation of the instance settings.", "type": "string" }, "hash": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Cryptographic hash of the instance settings.", "type": "string" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Unencoded instance settings, if supported.", "type": "object" } @@ -14390,19 +23265,29 @@ "type": "object" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML representation of the widget.", "readonly": true, "type": "string" }, "rendered_form": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "HTML representation of the widget admin form.", "readonly": true, "type": "string" }, "sidebar": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": "wp_inactive_widgets", "description": "The sidebar to which the widget belongs.", "required": true, @@ -14416,32 +23301,52 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "classname": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Class name", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Description of the widget.", "type": "string" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique slug identifying the widget type.", "readonly": true, "type": "string" }, "is_multi": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the widget supports multiple instances", "readonly": true, "type": "boolean" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Human-readable name identifying the widget type.", "readonly": true, @@ -14463,11 +23368,21 @@ "description": "The category this test is grouped in.", "properties": { "color": { - "enum": ["blue", "orange", "red", "green", "purple", "gray"], + "enum": [ + "blue", + "gray", + "green", + "orange", + "purple", + "red" + ], "readonly": true, "type": "string" }, - "label": { "readonly": true, "type": "string" } + "label": { + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" @@ -14477,14 +23392,26 @@ "readonly": true, "type": "string" }, - "label": { "description": "A label describing the test.", "readonly": true, "type": "string" }, - "status": { - "description": "The status of the test.", - "enum": ["good", "recommended", "critical"], + "label": { + "description": "A label describing the test.", "readonly": true, "type": "string" }, - "test": { "description": "The name of the test being run.", "readonly": true, "type": "string" } + "status": { + "description": "The status of the test.", + "enum": [ + "critical", + "good", + "recommended" + ], + "readonly": true, + "type": "string" + }, + "test": { + "description": "The name of the test being run.", + "readonly": true, + "type": "string" + } }, "title": "wp-site-health-test", "type": "object" @@ -14496,7 +23423,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -14504,14 +23439,30 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", "rel": "https:/api.w.org/action-assign-wp_pattern_category", "targetSchema": { - "properties": { "wp_pattern_category": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "wp_pattern_category": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the wp_pattern_category taxonomy." @@ -14520,7 +23471,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", "rel": "https:/api.w.org/action-create-wp_pattern_category", "targetSchema": { - "properties": { "wp_pattern_category": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "wp_pattern_category": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the wp_pattern_category taxonomy." @@ -14528,23 +23486,35 @@ ], "properties": { "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the post, as it exists in the database.", "type": "string" } @@ -14552,34 +23522,61 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -14588,17 +23585,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -14608,87 +23613,130 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", "properties": { - "footnotes": { "default": "", "description": "", "type": "string" }, + "footnotes": { + "default": "", + "description": "", + "type": "string" + }, "wp_pattern_sync_status": { "default": "", "description": "", - "enum": ["partial", "unsynced"], + "enum": [ + "partial", + "unsynced" + ], "type": "string" } }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Title for the object, as it exists in the database.", "type": "string" } @@ -14696,15 +23744,24 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" }, "wp_pattern_category": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -14715,28 +23772,44 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the post, as it exists in the database.", "type": "string" } @@ -14744,34 +23817,55 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -14780,17 +23874,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -14800,59 +23902,96 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", "properties": { - "footnotes": { "default": "", "description": "", "type": "string" }, + "footnotes": { + "default": "", + "description": "", + "type": "string" + }, "wp_pattern_sync_status": { "default": "", "description": "", - "enum": ["partial", "unsynced"], + "enum": [ + "partial", + "unsynced" + ], "type": "string" } }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Title for the object, as it exists in the database.", "type": "string" } @@ -14868,59 +24007,132 @@ "properties": { "font_face_settings": { "additionalProperties": false, - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "font-face declaration in theme.json format.", "properties": { - "ascentOverride": { "description": "CSS ascent-override value.", "type": "string" }, - "descentOverride": { "description": "CSS descent-override value.", "type": "string" }, + "ascentOverride": { + "description": "CSS ascent-override value.", + "type": "string" + }, + "descentOverride": { + "description": "CSS descent-override value.", + "type": "string" + }, "fontDisplay": { "default": "fallback", "description": "CSS font-display value.", - "enum": ["auto", "block", "fallback", "swap", "optional"], + "enum": [ + "auto", + "block", + "fallback", + "optional", + "swap" + ], + "type": "string" + }, + "fontFamily": { + "default": "", + "description": "CSS font-family value.", + "type": "string" + }, + "fontFeatureSettings": { + "description": "CSS font-feature-settings value.", + "type": "string" + }, + "fontStretch": { + "description": "CSS font-stretch value.", + "type": "string" + }, + "fontStyle": { + "default": "normal", + "description": "CSS font-style value.", + "type": "string" + }, + "fontVariant": { + "description": "CSS font-variant value.", + "type": "string" + }, + "fontVariationSettings": { + "description": "CSS font-variation-settings value.", "type": "string" }, - "fontFamily": { "default": "", "description": "CSS font-family value.", "type": "string" }, - "fontFeatureSettings": { "description": "CSS font-feature-settings value.", "type": "string" }, - "fontStretch": { "description": "CSS font-stretch value.", "type": "string" }, - "fontStyle": { "default": "normal", "description": "CSS font-style value.", "type": "string" }, - "fontVariant": { "description": "CSS font-variant value.", "type": "string" }, - "fontVariationSettings": { "description": "CSS font-variation-settings value.", "type": "string" }, "fontWeight": { "default": "400", "description": "List of available font weights, separated by a space.", - "type": ["string", "integer"] + "type": [ + "integer", + "string" + ] + }, + "lineGapOverride": { + "description": "CSS line-gap-override value.", + "type": "string" }, - "lineGapOverride": { "description": "CSS line-gap-override value.", "type": "string" }, "preview": { "default": "", "description": "URL to a preview image of the font face.", "format": "uri", "type": "string" }, - "sizeAdjust": { "description": "CSS size-adjust value.", "type": "string" }, + "sizeAdjust": { + "description": "CSS size-adjust value.", + "type": "string" + }, "src": { - "anyOf": [{ "type": "string" }, { "items": { "type": "string" }, "type": "array" }], + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], "default": [], "description": "Paths or URLs to the font files." }, - "unicodeRange": { "description": "CSS unicode-range value.", "type": "string" } + "unicodeRange": { + "description": "CSS unicode-range value.", + "type": "string" + } }, - "required": ["fontFamily", "src"], + "required": [ + "fontFamily", + "src" + ], "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent font family of the font face.", "type": "integer" }, "theme_json_version": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 3, "description": "Version of the theme.json schema used for the typography settings.", "maximum": 3, @@ -14935,37 +24147,68 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "font_faces": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The IDs of the child font faces in the font family.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "font_family_settings": { "additionalProperties": false, - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "font-face definition in theme.json format.", "properties": { - "fontFamily": { "description": "CSS font-family value.", "type": "string" }, - "name": { "description": "Name of the font family preset, translatable.", "type": "string" }, + "fontFamily": { + "description": "CSS font-family value.", + "type": "string" + }, + "name": { + "description": "Name of the font family preset, translatable.", + "type": "string" + }, "preview": { "default": "", "description": "URL to a preview image of the font family.", "format": "uri", "type": "string" }, - "slug": { "description": "Kebab-case unique identifier for the font family preset.", "type": "string" } + "slug": { + "description": "Kebab-case unique identifier for the font family preset.", + "type": "string" + } }, - "required": ["name", "slug", "fontFamily"], + "required": [ + "fontFamily", + "name", + "slug" + ], "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "theme_json_version": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 3, "description": "Version of the theme.json schema used for the typography settings.", "maximum": 3, @@ -14980,31 +24223,68 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of global styles config.", "readonly": true, "type": "string" }, - "settings": { "context": ["view", "edit"], "description": "Global settings.", "type": ["object"] }, - "styles": { "context": ["view", "edit"], "description": "Global styles.", "type": ["object"] }, + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "context": [ + "edit", + "view" + ], + "description": "Global styles.", + "type": [ + "object" + ] + }, "title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Title of the global styles variation.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the global styles variation, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] } }, "title": "wp_global_styles", @@ -15014,47 +24294,90 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of global styles config.", "readonly": true, "type": "string" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, - "settings": { "context": ["view", "edit"], "description": "Global settings.", "type": ["object"] }, - "styles": { "context": ["view", "edit"], "description": "Global styles.", "type": ["object"] } + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "context": [ + "edit", + "view" + ], + "description": "Global styles.", + "type": [ + "object" + ] + } }, "title": "wp_global_styles-revision", "type": "object" @@ -15066,7 +24389,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -15074,34 +24405,61 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." } ], "properties": { "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -15110,29 +24468,50 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -15142,78 +24521,116 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -15222,7 +24639,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -15235,33 +24656,55 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -15270,29 +24713,44 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -15302,51 +24760,90 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -15362,45 +24859,81 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["wp_pattern_category"], + "enum": [ + "wp_pattern_category" + ], "readonly": true, "type": "string" } @@ -15412,81 +24945,137 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the template.", "type": "integer" }, "author_text": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Human readable text for the author.", "readonly": true, "type": "string" }, "content": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Description of template.", "type": "string" }, "has_theme_file": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Theme file exists.", "readonly": true, "type": "bool" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of template.", "readonly": true, "type": "string" }, "is_custom": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether a template is a custom template.", "readonly": true, "type": "bool" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the template was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "origin": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Source of a customised template", "readonly": true, "type": "string" }, "original_source": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "From where the template originally comes, eg 'theme'", - "enum": ["theme", "plugin", "site", "user"], + "enum": [ + "plugin", + "site", + "theme", + "user" + ], "readonly": true, "type": "string" }, "slug": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", @@ -15494,59 +25083,98 @@ "type": "string" }, "source": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Source of template", "readonly": true, "type": "string" }, "status": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "publish", "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "theme": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Theme identifier for the template.", "type": "string" }, "title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of template.", + "type": "string" }, - "type": { "context": ["embed", "view", "edit"], "description": "Type of template.", "type": "string" }, "wp_id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Post ID.", "readonly": true, "type": "integer" @@ -15559,80 +25187,136 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "area": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the template.", "type": "integer" }, "author_text": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Human readable text for the author.", "readonly": true, "type": "string" }, "content": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Description of template.", "type": "string" }, "has_theme_file": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Theme file exists.", "readonly": true, "type": "bool" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of template.", "readonly": true, "type": "string" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the template was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "origin": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Source of a customised template", "readonly": true, "type": "string" }, "original_source": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "From where the template originally comes, eg 'theme'", - "enum": ["theme", "plugin", "site", "user"], + "enum": [ + "plugin", + "site", + "theme", + "user" + ], "readonly": true, "type": "string" }, "slug": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", @@ -15640,59 +25324,98 @@ "type": "string" }, "source": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Source of template", "readonly": true, "type": "string" }, "status": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "publish", "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "theme": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Theme identifier for the template.", "type": "string" }, "title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of template.", + "type": "string" }, - "type": { "context": ["embed", "view", "edit"], "description": "Type of template.", "type": "string" }, "wp_id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Post ID.", "readonly": true, "type": "integer" @@ -15704,7 +25427,11 @@ } }, "info": { - "contact": { "email": "contact@gcch.fr", "name": "Haiku Atelier", "url": "https:/haikuatelier.fr.ddev.site" }, + "contact": { + "email": "contact@gcch.fr", + "name": "Haiku Atelier", + "url": "https:/haikuatelier.fr.ddev.site" + }, "description": "", "title": "Haiku Atelier API", "version": "6.6.1" @@ -15714,14 +25441,46 @@ "/carbon-fields/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/carbon-fields/v1/association": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/carbon-fields/v1/association/options": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/carbon-fields/v1/association": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/carbon-fields/v1/association/options": { "get": { "responses": { "200": { "description": "OK" } } } }, "/carbon-fields/v1/attachment": { "get": { "parameters": [ @@ -15740,7 +25499,11 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/block-renderer": { @@ -15750,73 +25513,182 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content of the block.", "required": true, "type": "string" }, - "name": { "description": "The name of the block.", "required": true, "type": "string" }, - "post_id": { "description": "ID of the post context.", "type": "integer" } + "content": { + "description": "The content of the block.", + "required": true, + "type": "string" + }, + "name": { + "description": "The name of the block.", + "required": true, + "type": "string" + }, + "post_id": { + "description": "ID of the post context.", + "type": "integer" + } }, - "required": ["name", "content"], + "required": [ + "content", + "name" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/comments/{id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/options": { - "get": { "responses": { "200": { "description": "OK" } } }, - "post": { "responses": { "200": { "description": "OK" } } } + "get": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/carbon-fields/v1/posts/{id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/terms/{id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/users/{id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4/connection": { - "get": { "responses": { "200": { "description": "OK" } } }, + "get": { + "responses": { + "200": { + "description": "OK" + } + } + }, "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "isActive": { "description": "Set to false will trigger the site to disconnect.", "required": true } + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true + } }, - "required": ["isActive"], + "required": [ + "isActive" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -15824,15 +25696,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "isActive": { "description": "Set to false will trigger the site to disconnect.", "required": true } + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true + } }, - "required": ["isActive"], + "required": [ + "isActive" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -15840,15 +25721,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "isActive": { "description": "Set to false will trigger the site to disconnect.", "required": true } + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true + } }, - "required": ["isActive"], + "required": [ + "isActive" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4/connection/authorize_url": { @@ -15862,59 +25752,133 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/connection/data": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/jetpack/v4/connection/data": { "get": { "responses": { "200": { "description": "OK" } } } }, "/jetpack/v4/connection/owner": { "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "owner": { "description": "New owner", "required": true, "type": "integer" } }, - "required": ["owner"], + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "owner": { "description": "New owner", "required": true, "type": "integer" } }, - "required": ["owner"], + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "owner": { "description": "New owner", "required": true, "type": "integer" } }, - "required": ["owner"], + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/connection/plugins": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/jetpack/v4/connection/plugins": { "get": { "responses": { "200": { "description": "OK" } } } }, "/jetpack/v4/connection/reconnect": { - "patch": { "responses": { "200": { "description": "OK" } } }, - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } } + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/jetpack/v4/connection/register": { "patch": { @@ -15935,15 +25899,25 @@ "description": "URI of the admin page where the user should be redirected after connection flow", "type": "string" }, - "registration_nonce": { "description": "The registration nonce", "required": true, "type": "string" } + "registration_nonce": { + "description": "The registration nonce", + "required": true, + "type": "string" + } }, - "required": ["registration_nonce"], + "required": [ + "registration_nonce" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -15963,15 +25937,25 @@ "description": "URI of the admin page where the user should be redirected after connection flow", "type": "string" }, - "registration_nonce": { "description": "The registration nonce", "required": true, "type": "string" } + "registration_nonce": { + "description": "The registration nonce", + "required": true, + "type": "string" + } }, - "required": ["registration_nonce"], + "required": [ + "registration_nonce" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -15991,21 +25975,49 @@ "description": "URI of the admin page where the user should be redirected after connection flow", "type": "string" }, - "registration_nonce": { "description": "The registration nonce", "required": true, "type": "string" } + "registration_nonce": { + "description": "The registration nonce", + "required": true, + "type": "string" + } }, - "required": ["registration_nonce"], + "required": [ + "registration_nonce" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4/remote_authorize": { - "patch": { "responses": { "200": { "description": "OK" } } }, - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } } + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/jetpack/v4/user-token": { "patch": { @@ -16014,16 +26026,29 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "is_connection_owner": { "description": "Is connection owner", "type": "boolean" }, - "user_token": { "description": "New user token", "required": true, "type": "string" } + "is_connection_owner": { + "description": "Is connection owner", + "type": "boolean" + }, + "user_token": { + "description": "New user token", + "required": true, + "type": "string" + } }, - "required": ["user_token"], + "required": [ + "user_token" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -16031,16 +26056,29 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "is_connection_owner": { "description": "Is connection owner", "type": "boolean" }, - "user_token": { "description": "New user token", "required": true, "type": "string" } + "is_connection_owner": { + "description": "Is connection owner", + "type": "boolean" + }, + "user_token": { + "description": "New user token", + "required": true, + "type": "string" + } }, - "required": ["user_token"], + "required": [ + "user_token" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -16048,22 +26086,53 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "is_connection_owner": { "description": "Is connection owner", "type": "boolean" }, - "user_token": { "description": "New user token", "required": true, "type": "string" } + "is_connection_owner": { + "description": "Is connection owner", + "type": "boolean" + }, + "user_token": { + "description": "New user token", + "required": true, + "type": "string" + } }, - "required": ["user_token"], + "required": [ + "user_token" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4/verify_registration": { - "patch": { "responses": { "200": { "description": "OK" } } }, - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } } + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/jetpack/v4/verify_xmlrpc_error": { "post": { @@ -16071,30 +26140,63 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "nonce": { "required": true, "type": "string" } }, - "required": ["nonce"], + "properties": { + "nonce": { + "required": true, + "type": "string" + } + }, + "required": [ + "nonce" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin/experiments/assignment": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16104,33 +26206,76 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } } }, "/wc-admin/launch-your-store/initialize-coming-soon": { - "post": { "responses": { "200": { "description": "OK" } } } + "post": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/launch-your-store/survey-completed": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } }, - "/wc-admin/launch-your-store/survey-completed": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wc-admin/launch-your-store/update-survey-status": { "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } + "schema": { + "properties": { + "status": { + "type": "string" + } + }, + "type": "object" + } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin/launch-your-store/woopayments/test-orders": { - "delete": { "responses": { "200": { "description": "OK" } } } + "delete": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/wc-admin/launch-your-store/woopayments/test-orders/count": { - "get": { "responses": { "200": { "description": "OK" } } } + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/wc-admin/marketing/campaign-types": { "get": { @@ -16140,27 +26285,40 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/marketing_campaign_type" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_campaign_type" + } + } }, "description": "OK" } @@ -16175,26 +26333,41 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_campaign" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_campaign" + } + } + }, "description": "OK" } } @@ -16204,7 +26377,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_channel" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_channel" + } + } + }, "description": "OK" } } @@ -16212,10 +26391,24 @@ }, "/wc-admin/marketing/knowledge-base": { "get": { - "parameters": [{ "description": "", "in": "query", "name": "category", "required": false, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "query", + "name": "category", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16227,8 +26420,15 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "plugin": { "required": true, "type": "string" } }, - "required": ["plugin"], + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], "type": "object" } } @@ -16236,7 +26436,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16246,8 +26452,15 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "plugin": { "required": true, "type": "string" } }, - "required": ["plugin"], + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], "type": "object" } } @@ -16255,7 +26468,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16265,8 +26484,15 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "plugin": { "required": true, "type": "string" } }, - "required": ["plugin"], + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], "type": "object" } } @@ -16274,7 +26500,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16284,7 +26516,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16298,13 +26536,22 @@ "in": "query", "name": "category", "required": true, - "schema": { "enum": ["channels", "extensions"] } + "schema": { + "enum": [ + "channels", + "extensions" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/marketing_recommendation" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_recommendation" + } + } }, "description": "OK" } @@ -16319,13 +26566,28 @@ "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, - { "description": "", "in": "query", "name": "category", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "category", + "required": false, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16335,7 +26597,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16345,7 +26613,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16356,13 +26630,29 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "item_id": { "required": true } }, "required": ["item_id"], "type": "object" } + "schema": { + "properties": { + "item_id": { + "required": true + } + }, + "required": [ + "item_id" + ], + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16370,7 +26660,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16379,24 +26675,54 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "item_id": { "required": true } }, "required": ["item_id"], "type": "object" } + "schema": { + "properties": { + "item_id": { + "required": true + } + }, + "required": [ + "item_id" + ], + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/notice/dismiss": { + "post": { + "responses": { + "200": { "description": "OK" } } } }, - "/wc-admin/notice/dismiss": { "post": { "responses": { "200": { "description": "OK" } } } }, "/wc-admin/onboarding/free-extensions": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16407,7 +26733,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Install and Activate Schema" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install and Activate Schema" + } + } }, "description": "OK" } @@ -16421,9 +26751,15 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "plugins": { "description": "A list of plugins to install", "required": true, "type": "array" } + "plugins": { + "description": "A list of plugins to install", + "required": true, + "type": "array" + } }, - "required": ["plugins"], + "required": [ + "plugins" + ], "type": "object" } } @@ -16431,7 +26767,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Install Async Schema" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install Async Schema" + } + } + }, "description": "OK" } } @@ -16455,15 +26797,33 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin/onboarding/plugins/scheduled-installs/{job_id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "job_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Install Async Schema" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install Async Schema" + } + } + }, "description": "OK" } } @@ -16473,7 +26833,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16483,7 +26849,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16493,7 +26865,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16504,13 +26882,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "business_extensions": { "description": "Extra business extensions to install.", "type": "array" }, - "completed": { "description": "Whether or not the profile was completed.", "type": "boolean" }, + "business_extensions": { + "description": "Extra business extensions to install.", + "type": "array" + }, + "completed": { + "description": "Whether or not the profile was completed.", + "type": "boolean" + }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "industry": { "description": "Industry.", "type": "array" }, + "industry": { + "description": "Industry.", + "type": "array" + }, "is_agree_marketing": { "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "type": "boolean" @@ -16523,23 +26910,50 @@ "description": "Whether or not this store country is set via onboarding profiler.", "type": "boolean" }, - "number_employees": { "description": "Number of employees of the store.", "type": "string" }, - "other_platform": { "description": "Name of other platform used to sell.", "type": "string" }, + "number_employees": { + "description": "Number of employees of the store.", + "type": "string" + }, + "other_platform": { + "description": "Name of other platform used to sell.", + "type": "string" + }, "other_platform_name": { "description": "Name of other platform used to sell (not listed).", "type": "string" }, - "product_count": { "description": "Number of products to be added.", "type": "string" }, - "product_types": { "description": "Types of products sold.", "type": "array" }, - "revenue": { "description": "Current annual revenue of the store.", "type": "string" }, - "selling_venues": { "description": "Other places the store is selling products.", "type": "string" }, + "product_count": { + "description": "Number of products to be added.", + "type": "string" + }, + "product_types": { + "description": "Types of products sold.", + "type": "array" + }, + "revenue": { + "description": "Current annual revenue of the store.", + "type": "string" + }, + "selling_venues": { + "description": "Other places the store is selling products.", + "type": "string" + }, "setup_client": { "description": "Whether or not this store was setup for a client.", "type": "boolean" }, - "skipped": { "description": "Whether or not the profile was skipped.", "type": "boolean" }, - "store_email": { "description": "Store email address.", "type": "string" }, - "theme": { "description": "Selected store theme.", "type": "string" }, + "skipped": { + "description": "Whether or not the profile was skipped.", + "type": "boolean" + }, + "store_email": { + "description": "Store email address.", + "type": "string" + }, + "theme": { + "description": "Selected store theme.", + "type": "string" + }, "wccom_connected": { "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", "type": "boolean" @@ -16552,7 +26966,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16563,13 +26983,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "business_extensions": { "description": "Extra business extensions to install.", "type": "array" }, - "completed": { "description": "Whether or not the profile was completed.", "type": "boolean" }, + "business_extensions": { + "description": "Extra business extensions to install.", + "type": "array" + }, + "completed": { + "description": "Whether or not the profile was completed.", + "type": "boolean" + }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "industry": { "description": "Industry.", "type": "array" }, + "industry": { + "description": "Industry.", + "type": "array" + }, "is_agree_marketing": { "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "type": "boolean" @@ -16582,23 +27011,50 @@ "description": "Whether or not this store country is set via onboarding profiler.", "type": "boolean" }, - "number_employees": { "description": "Number of employees of the store.", "type": "string" }, - "other_platform": { "description": "Name of other platform used to sell.", "type": "string" }, + "number_employees": { + "description": "Number of employees of the store.", + "type": "string" + }, + "other_platform": { + "description": "Name of other platform used to sell.", + "type": "string" + }, "other_platform_name": { "description": "Name of other platform used to sell (not listed).", "type": "string" }, - "product_count": { "description": "Number of products to be added.", "type": "string" }, - "product_types": { "description": "Types of products sold.", "type": "array" }, - "revenue": { "description": "Current annual revenue of the store.", "type": "string" }, - "selling_venues": { "description": "Other places the store is selling products.", "type": "string" }, + "product_count": { + "description": "Number of products to be added.", + "type": "string" + }, + "product_types": { + "description": "Types of products sold.", + "type": "array" + }, + "revenue": { + "description": "Current annual revenue of the store.", + "type": "string" + }, + "selling_venues": { + "description": "Other places the store is selling products.", + "type": "string" + }, "setup_client": { "description": "Whether or not this store was setup for a client.", "type": "boolean" }, - "skipped": { "description": "Whether or not the profile was skipped.", "type": "boolean" }, - "store_email": { "description": "Store email address.", "type": "string" }, - "theme": { "description": "Selected store theme.", "type": "string" }, + "skipped": { + "description": "Whether or not the profile was skipped.", + "type": "boolean" + }, + "store_email": { + "description": "Store email address.", + "type": "string" + }, + "theme": { + "description": "Selected store theme.", + "type": "string" + }, "wccom_connected": { "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", "type": "boolean" @@ -16611,7 +27067,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16622,13 +27084,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "business_extensions": { "description": "Extra business extensions to install.", "type": "array" }, - "completed": { "description": "Whether or not the profile was completed.", "type": "boolean" }, + "business_extensions": { + "description": "Extra business extensions to install.", + "type": "array" + }, + "completed": { + "description": "Whether or not the profile was completed.", + "type": "boolean" + }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "industry": { "description": "Industry.", "type": "array" }, + "industry": { + "description": "Industry.", + "type": "array" + }, "is_agree_marketing": { "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "type": "boolean" @@ -16641,23 +27112,50 @@ "description": "Whether or not this store country is set via onboarding profiler.", "type": "boolean" }, - "number_employees": { "description": "Number of employees of the store.", "type": "string" }, - "other_platform": { "description": "Name of other platform used to sell.", "type": "string" }, + "number_employees": { + "description": "Number of employees of the store.", + "type": "string" + }, + "other_platform": { + "description": "Name of other platform used to sell.", + "type": "string" + }, "other_platform_name": { "description": "Name of other platform used to sell (not listed).", "type": "string" }, - "product_count": { "description": "Number of products to be added.", "type": "string" }, - "product_types": { "description": "Types of products sold.", "type": "array" }, - "revenue": { "description": "Current annual revenue of the store.", "type": "string" }, - "selling_venues": { "description": "Other places the store is selling products.", "type": "string" }, + "product_count": { + "description": "Number of products to be added.", + "type": "string" + }, + "product_types": { + "description": "Types of products sold.", + "type": "array" + }, + "revenue": { + "description": "Current annual revenue of the store.", + "type": "string" + }, + "selling_venues": { + "description": "Other places the store is selling products.", + "type": "string" + }, "setup_client": { "description": "Whether or not this store was setup for a client.", "type": "boolean" }, - "skipped": { "description": "Whether or not the profile was skipped.", "type": "boolean" }, - "store_email": { "description": "Store email address.", "type": "string" }, - "theme": { "description": "Selected store theme.", "type": "string" }, + "skipped": { + "description": "Whether or not the profile was skipped.", + "type": "boolean" + }, + "store_email": { + "description": "Store email address.", + "type": "string" + }, + "theme": { + "description": "Selected store theme.", + "type": "string" + }, "wccom_connected": { "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", "type": "boolean" @@ -16670,7 +27168,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16680,7 +27184,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16694,12 +27204,27 @@ "in": "query", "name": "ids", "required": false, - "schema": { "items": { "enum": ["setup", "extended", "secret_tasklist"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "extended", + "secret_tasklist", + "setup" + ], + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16726,7 +27251,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16736,7 +27267,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16749,9 +27286,15 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "template_name": { "description": "Product template name.", "required": true, "type": "string" } + "template_name": { + "description": "Product template name.", + "required": true, + "type": "string" + } }, - "required": ["template_name"], + "required": [ + "template_name" + ], "type": "object" } } @@ -16759,7 +27302,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16769,7 +27318,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16777,28 +27332,70 @@ }, "/wc-admin/onboarding/tasks/{id}/action": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16806,28 +27403,70 @@ }, "/wc-admin/onboarding/tasks/{id}/dismiss": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16835,28 +27474,70 @@ }, "/wc-admin/onboarding/tasks/{id}/hide": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16864,14 +27545,28 @@ }, "/wc-admin/onboarding/tasks/{id}/snooze": { "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "duration": { "description": "Time period to snooze the task.", "type": "string" }, - "task_list_id": { "description": "Optional parameter to query specific task list.", "type": "string" } + "duration": { + "description": "Time period to snooze the task.", + "type": "string" + }, + "task_list_id": { + "description": "Optional parameter to query specific task list.", + "type": "string" + } }, "type": "object" } @@ -16880,7 +27575,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16888,28 +27589,70 @@ }, "/wc-admin/onboarding/tasks/{id}/undo_dismiss": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16917,28 +27660,70 @@ }, "/wc-admin/onboarding/tasks/{id}/undo_snooze": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16946,28 +27731,70 @@ }, "/wc-admin/onboarding/tasks/{id}/unhide": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16977,7 +27804,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -16985,7 +27818,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -16993,7 +27832,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -17003,7 +27848,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -17011,7 +27862,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -17019,7 +27876,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -17040,17 +27903,35 @@ "in": "query", "name": "currency", "required": false, - "schema": { "enum": ["USD", "AUD", "CAD", "EUR", "GBP"] } + "schema": { + "enum": [ + "AUD", + "CAD", + "EUR", + "GBP", + "USD" + ] + } } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin/options": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, "description": "OK" } } @@ -17058,7 +27939,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, "description": "OK" } } @@ -17066,7 +27953,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, "description": "OK" } } @@ -17074,7 +27967,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, "description": "OK" } } @@ -17094,7 +27993,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/payment-gateway-suggestions" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment-gateway-suggestions" + } + } }, "description": "OK" } @@ -17106,7 +28009,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/payment-gateway-suggestions" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment-gateway-suggestions" + } + } }, "description": "OK" } @@ -17117,7 +28024,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17125,7 +28038,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17133,7 +28052,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17143,7 +28068,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17151,10 +28082,24 @@ }, "/wc-admin/plugins/activate/status/{job_id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "job_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17164,7 +28109,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17174,7 +28125,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17184,7 +28141,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17192,7 +28155,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17200,7 +28169,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17210,7 +28185,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17218,7 +28199,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17226,7 +28213,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17236,7 +28229,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17246,7 +28245,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17254,7 +28259,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17262,7 +28273,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17272,7 +28289,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17280,10 +28303,24 @@ }, "/wc-admin/plugins/install/status/{job_id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "job_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17293,7 +28330,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17303,7 +28346,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17323,7 +28372,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping-partner-suggestions" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping-partner-suggestions" + } + } }, "description": "OK" } @@ -17341,7 +28394,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "pluginzip": { "description": "A zip file of the theme to be uploaded.", "type": "file" } + "pluginzip": { + "description": "A zip file of the theme to be uploaded.", + "type": "file" + } }, "type": "object" } @@ -17350,7 +28406,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, "description": "OK" } } @@ -17365,7 +28427,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "pluginzip": { "description": "A zip file of the theme to be uploaded.", "type": "file" } + "pluginzip": { + "description": "A zip file of the theme to be uploaded.", + "type": "file" + } }, "type": "object" } @@ -17374,7 +28439,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, "description": "OK" } } @@ -17389,7 +28460,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "pluginzip": { "description": "A zip file of the theme to be uploaded.", "type": "file" } + "pluginzip": { + "description": "A zip file of the theme to be uploaded.", + "type": "file" + } }, "type": "object" } @@ -17398,7 +28472,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, "description": "OK" } } @@ -17407,10 +28487,26 @@ "/wc-analytics": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-analytics/admin/notes": { @@ -17421,35 +28517,58 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["note_id", "date", "type", "title", "status"] } + "schema": { + "enum": [ + "date", + "note_id", + "status", + "title", + "type" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Type of note.", @@ -17458,7 +28577,15 @@ "required": false, "schema": { "items": { - "enum": ["error", "warning", "update", "info", "marketing", "survey", "email"], + "enum": [ + "email", + "error", + "info", + "marketing", + "survey", + "update", + "warning" + ], "type": "string" } } @@ -17469,7 +28596,16 @@ "name": "status", "required": false, "schema": { - "items": { "enum": ["pending", "actioned", "unactioned", "snoozed", "sent"], "type": "string" } + "items": { + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], + "type": "string" + } } }, { @@ -17477,12 +28613,22 @@ "in": "query", "name": "source", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17494,7 +28640,12 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "status": { "description": "Status of note.", "type": "array" } }, + "properties": { + "status": { + "description": "Status of note.", + "type": "array" + } + }, "type": "object" } } @@ -17502,7 +28653,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17510,10 +28667,24 @@ }, "/wc-analytics/admin/notes/delete/{id}": { "delete": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17521,28 +28692,70 @@ }, "/wc-analytics/admin/notes/experimental-activate-promo/{promo_note_name}": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "promo_note_name", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "promo_note_name", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "promo_note_name", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17551,12 +28764,30 @@ "/wc-analytics/admin/notes/tracker/{note_id}/user/{user_id}": { "get": { "parameters": [ - { "description": "", "in": "path", "name": "note_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17566,7 +28797,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17574,7 +28811,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17582,7 +28825,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17591,44 +28840,92 @@ "/wc-analytics/admin/notes/{id}": { "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17637,7 +28934,13 @@ "/wc-analytics/admin/notes/{note_id}/action/{action_id}": { "patch": { "parameters": [ - { "description": "Unique ID for the Note.", "in": "path", "name": "note_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the Note.", + "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the Note Action.", "in": "path", @@ -17648,14 +28951,26 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the Note.", "in": "path", "name": "note_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the Note.", + "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the Note Action.", "in": "path", @@ -17666,14 +28981,26 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the Note.", "in": "path", "name": "note_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the Note.", + "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the Note Action.", "in": "path", @@ -17684,7 +29011,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17698,21 +29031,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to coupons with codes matching a given string.", @@ -17726,28 +29069,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -17761,14 +29112,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -17782,14 +29141,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to resources with a specific code.", @@ -17801,7 +29174,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -17816,16 +29195,29 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "required": true, "type": "string" }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -17862,7 +29254,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -17871,7 +29266,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -17885,7 +29283,9 @@ "type": "integer" } }, - "required": ["code"], + "required": [ + "code" + ], "type": "object" } } @@ -17893,7 +29293,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -17910,16 +29316,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -17956,7 +29374,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -17965,7 +29386,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -17986,7 +29410,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -18001,16 +29431,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18047,7 +29489,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18056,7 +29501,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18077,7 +29525,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -18092,16 +29546,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18138,7 +29604,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18147,7 +29616,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18168,7 +29640,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -18190,7 +29668,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -18199,7 +29680,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18218,12 +29705,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18247,16 +29745,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18293,7 +29803,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18302,7 +29815,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18323,7 +29839,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18347,16 +29869,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18393,7 +29927,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18402,7 +29939,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18423,7 +29963,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18447,16 +29993,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18493,7 +30051,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18502,7 +30063,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18523,7 +30087,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18537,42 +30107,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -18581,17 +30170,17 @@ "required": false, "schema": { "enum": [ - "username", - "name", - "country", + "avg_order_value", "city", - "state", - "postcode", - "date_registered", + "country", "date_last_active", + "date_registered", + "name", "orders_count", + "postcode", + "state", "total_spend", - "avg_order_value" + "username" ] } }, @@ -18607,21 +30196,30 @@ "in": "query", "name": "registered_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", @@ -18635,7 +30233,14 @@ "in": "query", "name": "searchby", "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } }, { "description": "Limit response to objects with specific names.", @@ -18698,28 +30303,40 @@ "in": "query", "name": "last_active_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_active_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "last_active_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "registered_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects with an order count greater than or equal to given integer.", @@ -18740,7 +30357,11 @@ "in": "query", "name": "orders_count_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with a total order spend greater than or equal to given number.", @@ -18761,7 +30382,11 @@ "in": "query", "name": "total_spend_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with an average order spend greater than or equal to given number.", @@ -18782,28 +30407,40 @@ "in": "query", "name": "avg_order_value_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result to items with specified user IDs.", "in": "query", "name": "users", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Filter out results where any of the passed fields are empty", @@ -18811,7 +30448,17 @@ "name": "filter_empty", "required": false, "schema": { - "items": { "enum": ["email", "name", "country", "city", "state", "postcode"], "type": "string" } + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } } }, { @@ -18819,12 +30466,22 @@ "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, "description": "OK" } } @@ -18833,48 +30490,73 @@ "/wc-analytics/customers/{id}": { "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -18883,17 +30565,17 @@ "required": false, "schema": { "enum": [ - "username", - "name", - "country", + "avg_order_value", "city", - "state", - "postcode", - "date_registered", + "country", "date_last_active", + "date_registered", + "name", "orders_count", + "postcode", + "state", "total_spend", - "avg_order_value" + "username" ] } }, @@ -18909,21 +30591,30 @@ "in": "query", "name": "registered_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", @@ -18937,7 +30628,14 @@ "in": "query", "name": "searchby", "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } }, { "description": "Limit response to objects with specific names.", @@ -19000,28 +30698,40 @@ "in": "query", "name": "last_active_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_active_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "last_active_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "registered_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects with an order count greater than or equal to given integer.", @@ -19042,7 +30752,11 @@ "in": "query", "name": "orders_count_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with a total order spend greater than or equal to given number.", @@ -19063,7 +30777,11 @@ "in": "query", "name": "total_spend_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with an average order spend greater than or equal to given number.", @@ -19084,28 +30802,40 @@ "in": "query", "name": "avg_order_value_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result to items with specified user IDs.", "in": "query", "name": "users", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Filter out results where any of the passed fields are empty", @@ -19113,7 +30843,17 @@ "name": "filter_empty", "required": false, "schema": { - "items": { "enum": ["email", "name", "country", "city", "state", "postcode"], "type": "string" } + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } } }, { @@ -19121,12 +30861,22 @@ "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, "description": "OK" } } @@ -19136,7 +30886,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -19146,7 +30902,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -19156,7 +30918,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -19175,7 +30943,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -19185,7 +30959,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_download_ips" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_download_ips" + } + } + }, "description": "OK" } } @@ -19199,28 +30979,37 @@ "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 20, "minimum": 1 } + "schema": { + "maximum": 20, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "URL query to persist across links.", @@ -19232,7 +31021,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, "description": "OK" } } @@ -19242,7 +31037,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, "description": "OK" } } @@ -19256,35 +31057,51 @@ "in": "path", "name": "leaderboard", "required": true, - "schema": { "enum": ["customers", "coupons", "categories", "products"] } + "schema": { + "enum": [ + "categories", + "coupons", + "customers", + "products" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 20, "minimum": 1 } + "schema": { + "maximum": 20, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "URL query to persist across links.", @@ -19296,7 +31113,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, "description": "OK" } } @@ -19310,21 +31133,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -19338,28 +31171,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -19373,14 +31214,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -19394,28 +31243,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to orders which have specific statuses.", @@ -19426,15 +31297,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -19473,14 +31344,22 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to orders matching part of an order number.", @@ -19492,7 +31371,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19503,32 +31388,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19537,7 +31464,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19550,32 +31483,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19584,7 +31559,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -19595,32 +31576,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19629,7 +31652,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -19640,32 +31669,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19674,7 +31745,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -19696,7 +31773,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -19705,7 +31785,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19724,12 +31810,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19749,32 +31846,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19783,7 +31922,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19803,32 +31948,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19837,7 +32024,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19857,32 +32050,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19891,7 +32126,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19905,21 +32146,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Search by similar product name or SKU.", @@ -19933,28 +32185,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -19968,14 +32228,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -19989,7 +32257,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -20001,17 +32274,17 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", - "rating", - "menu_order", + "popularity", "price", - "popularity", - "rating" + "rating", + "rating", + "rating", + "slug", + "title" ] } }, @@ -20020,14 +32293,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -20041,14 +32322,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -20125,21 +32423,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit results to those with a SKU that partially matches a string.", @@ -20158,7 +32470,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -20169,7 +32487,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -20178,36 +32499,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -20216,50 +32573,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -20268,7 +32712,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -20282,7 +32732,12 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Search by similar attribute name.", @@ -20294,7 +32749,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20305,16 +32766,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -20322,7 +32798,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20335,14 +32817,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -20351,7 +32845,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20362,14 +32862,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -20378,7 +32890,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20389,14 +32907,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -20405,7 +32935,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20426,21 +32962,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -20454,14 +33000,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -20475,14 +33029,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -20516,7 +33085,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20537,15 +33110,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -20554,7 +33139,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20577,9 +33166,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20592,7 +33190,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20612,9 +33216,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20627,7 +33240,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20647,9 +33266,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20662,7 +33290,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20704,7 +33338,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20731,13 +33369,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20765,9 +33412,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20781,7 +33437,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20809,9 +33469,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20825,7 +33494,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20853,9 +33526,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20869,7 +33551,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20904,7 +33590,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20923,12 +33615,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20948,14 +33651,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -20964,7 +33679,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20984,14 +33705,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -21000,7 +33733,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -21020,14 +33759,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -21036,7 +33787,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -21055,7 +33812,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -21076,21 +33839,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -21104,14 +33877,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -21125,14 +33906,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -21159,7 +33955,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -21173,7 +33973,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -21182,36 +33985,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -21220,50 +34059,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -21272,7 +34198,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21283,7 +34215,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -21292,36 +34227,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -21330,50 +34301,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -21382,7 +34440,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21393,7 +34457,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -21402,36 +34469,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -21440,50 +34543,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -21492,7 +34682,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21506,21 +34702,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -21534,14 +34740,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -21555,14 +34769,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -21595,7 +34824,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21606,18 +34841,39 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -21625,7 +34881,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21638,12 +34900,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21656,7 +34936,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21667,12 +34953,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21685,7 +34989,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21696,12 +35006,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21714,7 +35042,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21748,7 +35082,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21767,12 +35107,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21792,12 +35143,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21810,7 +35179,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21830,12 +35205,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21848,7 +35241,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21868,12 +35267,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21886,7 +35303,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21900,20 +35323,37 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit result set to products assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["draft", "pending", "private", "publish", "future"] } + "schema": { + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Count Low in Stock Items" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/Count Low in Stock Items" + } + } }, "description": "OK" } @@ -21928,33 +35368,57 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit result set to products assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["draft", "pending", "private", "publish", "future"] } + "schema": { + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -21968,21 +35432,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -21996,28 +35470,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to reviews published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -22031,54 +35517,95 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "product"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ] + } }, { "description": "Limit result set to reviews assigned to specific user IDs.", "in": "query", "name": "reviewer", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes reviews assigned to specific user IDs.", "in": "query", "name": "reviewer_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to that from a specific author email.", "in": "query", "name": "reviewer_email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to reviews assigned to specific product IDs.", "in": "query", "name": "product", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to reviews assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "hold", "approved", "spam", "trash"] } + "schema": { + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22094,14 +35621,40 @@ "required": true, "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "Review content.", "required": true, "type": "string" }, - "reviewer": { "description": "Name of the reviewer.", "required": true, "type": "string" }, - "reviewer_email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + }, + "reviewer": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "reviewer_email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, - "required": ["product_id", "reviewer", "reviewer_email", "review"], + "required": [ + "product_id", + "review", + "reviewer", + "reviewer_email" + ], "type": "object" } } @@ -22109,7 +35662,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22126,12 +35685,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22140,7 +35717,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -22155,12 +35738,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22169,7 +35770,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -22184,12 +35791,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22198,7 +35823,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -22220,7 +35851,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -22229,7 +35863,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22248,12 +35888,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22277,12 +35928,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22291,7 +35960,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22315,12 +35990,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22329,7 +36022,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22353,12 +36052,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22367,7 +36084,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22381,21 +36104,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -22409,28 +36143,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -22444,14 +36186,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -22465,7 +36215,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -22477,14 +36232,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ] } }, @@ -22493,14 +36248,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -22514,14 +36277,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -22605,28 +36385,44 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to specific product categorie ids.", "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific product tag ids.", "in": "query", "name": "tags", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific amount of suggested products.", @@ -22638,7 +36434,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22660,7 +36462,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -22669,7 +36474,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22688,12 +36499,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22713,7 +36536,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -22722,36 +36548,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -22760,50 +36622,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -22812,7 +36761,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22832,7 +36787,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -22841,36 +36799,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -22879,50 +36873,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -22931,7 +37012,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22951,7 +37038,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -22960,36 +37050,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -22998,50 +37124,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23050,7 +37263,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -23072,7 +37291,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -23081,36 +37303,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23119,50 +37377,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23171,7 +37516,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -23192,21 +37543,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Search by similar product name, SKU, or attribute value.", @@ -23220,28 +37581,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -23255,14 +37624,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -23276,28 +37653,51 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -23311,7 +37711,17 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -23346,21 +37756,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit result set to products with or without price.", @@ -23377,9 +37801,18 @@ "schema": { "items": { "properties": { - "attribute": { "description": "Attribute slug.", "type": "string" }, - "term": { "description": "Attribute term.", "type": "string" }, - "terms": { "description": "Attribute terms.", "type": "array" } + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } }, "type": "object" } @@ -23388,7 +37821,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23408,29 +37847,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23439,31 +37899,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23472,7 +37998,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23494,29 +38026,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23525,31 +38078,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23558,7 +38177,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -23578,29 +38203,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23609,31 +38255,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23642,7 +38354,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -23662,29 +38380,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23693,31 +38432,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23726,7 +38531,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -23748,31 +38559,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_values": { + "description": "Default values for generated variations.", + "type": "object" + }, + "delete": { + "description": "Deletes unused variations.", + "type": "boolean" + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "default_values": { "description": "Default values for generated variations.", "type": "object" }, - "delete": { "description": "Deletes unused variations.", "type": "boolean" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23781,31 +38619,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23814,7 +38718,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23843,7 +38753,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -23852,7 +38765,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23878,12 +38797,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23910,29 +38840,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23941,31 +38892,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23974,7 +38991,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -24001,29 +39024,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -24032,31 +39076,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -24065,7 +39175,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -24092,29 +39208,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -24123,31 +39260,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -24156,7 +39359,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -24170,12 +39379,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, "description": "OK" } } @@ -24189,42 +39408,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -24232,7 +39470,14 @@ "name": "orderby", "required": false, "schema": { - "enum": ["category_id", "items_sold", "net_revenue", "orders_count", "products_count", "category"] + "enum": [ + "category", + "category_id", + "items_sold", + "net_revenue", + "orders_count", + "products_count" + ] } }, { @@ -24240,7 +39485,16 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Limit result set to items that have the specified order status.", @@ -24251,15 +39505,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -24274,15 +39528,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -24293,7 +39547,11 @@ "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Add additional piece of info about each category to the report.", @@ -24312,7 +39570,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_categories" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_categories" + } + } + }, "description": "OK" } } @@ -24326,49 +39590,75 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["coupon_id", "code", "amount", "orders_count"] } + "schema": { + "enum": [ + "amount", + "code", + "coupon_id", + "orders_count" + ] + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -24382,7 +39672,11 @@ "in": "query", "name": "coupons", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Add additional piece of info about each coupon to the report.", @@ -24394,7 +39688,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupons" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupons" + } + } + }, "description": "OK" } } @@ -24408,49 +39708,75 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "amount", "coupons_count", "orders_count"] } + "schema": { + "enum": [ + "amount", + "coupons_count", + "date", + "orders_count" + ] + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -24464,33 +39790,63 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Limit result set to coupons assigned specific coupon IDs.", "in": "query", "name": "coupons", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "variation", "category", "coupon"] } + "schema": { + "enum": [ + "category", + "coupon", + "product", + "variation" + ] + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupons_stats" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupons_stats" + } + } + }, "description": "OK" } } @@ -24504,42 +39860,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -24548,17 +39923,17 @@ "required": false, "schema": { "enum": [ - "username", - "name", - "country", + "avg_order_value", "city", - "state", - "postcode", - "date_registered", + "country", "date_last_active", + "date_registered", + "name", "orders_count", + "postcode", + "state", "total_spend", - "avg_order_value" + "username" ] } }, @@ -24574,21 +39949,30 @@ "in": "query", "name": "registered_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", @@ -24602,7 +39986,14 @@ "in": "query", "name": "searchby", "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } }, { "description": "Limit response to objects with specific names.", @@ -24665,28 +40056,40 @@ "in": "query", "name": "last_active_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_active_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "last_active_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "registered_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects with an order count greater than or equal to given integer.", @@ -24707,7 +40110,11 @@ "in": "query", "name": "orders_count_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with a total order spend greater than or equal to given number.", @@ -24728,7 +40135,11 @@ "in": "query", "name": "total_spend_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with an average order spend greater than or equal to given number.", @@ -24749,35 +40160,51 @@ "in": "query", "name": "avg_order_value_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result to items with specified customer IDs.", "in": "query", "name": "customers", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result to items with specified user IDs.", "in": "query", "name": "users", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Filter out results where any of the passed fields are empty", @@ -24785,13 +40212,29 @@ "name": "filter_empty", "required": false, "schema": { - "items": { "enum": ["email", "name", "country", "city", "state", "postcode"], "type": "string" } + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, "description": "OK" } } @@ -24805,28 +40248,42 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", @@ -24840,7 +40297,14 @@ "in": "query", "name": "searchby", "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } }, { "description": "Limit response to objects with specific names.", @@ -24903,28 +40367,40 @@ "in": "query", "name": "last_active_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_active_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "last_active_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "registered_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects with an order count greater than or equal to given integer.", @@ -24945,7 +40421,11 @@ "in": "query", "name": "orders_count_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with a total order spend greater than or equal to given number.", @@ -24966,7 +40446,11 @@ "in": "query", "name": "total_spend_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with an average order spend greater than or equal to given number.", @@ -24987,35 +40471,51 @@ "in": "query", "name": "avg_order_value_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result to items with specified customer IDs.", "in": "query", "name": "customers", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25028,7 +40528,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customers_stats" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers_stats" + } + } }, "description": "OK" } @@ -25043,112 +40547,173 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "product"] } + "schema": { + "enum": [ + "date", + "product" + ] + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: products, orders, username, ip_address.", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit result set to items that have the specified product(s) assigned.", "in": "query", "name": "product_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified product(s) assigned.", "in": "query", "name": "product_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified order IDs.", "in": "query", "name": "order_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified order IDs.", "in": "query", "name": "order_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that have the specified user IDs.", "in": "query", "name": "customer_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that don't have the specified user IDs.", "in": "query", "name": "customer_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that have a specified IP address.", "in": "query", "name": "ip_address_includes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects that don't have a specified IP address.", "in": "query", "name": "ip_address_excludes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25160,7 +40725,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_downloads" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_downloads" + } + } + }, "description": "OK" } } @@ -25174,49 +40745,73 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "download_count"] } + "schema": { + "enum": [ + "date", + "download_count" + ] + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25230,82 +40825,138 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit result set to items that have the specified product(s) assigned.", "in": "query", "name": "product_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified product(s) assigned.", "in": "query", "name": "product_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified order IDs.", "in": "query", "name": "order_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified order IDs.", "in": "query", "name": "order_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that have the specified customer IDs.", "in": "query", "name": "customer_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that don't have the specified customer IDs.", "in": "query", "name": "customer_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that have a specified IP address.", "in": "query", "name": "ip_address_includes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects that don't have a specified IP address.", "in": "query", "name": "ip_address_excludes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders_stats" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders_stats" + } + } + }, "description": "OK" } } @@ -25318,8 +40969,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "days": { "description": "Number of days to import.", "type": "integer" }, - "skip_existing": { "description": "Skip importing existing order data.", "type": "boolean" } + "days": { + "description": "Number of days to import.", + "type": "integer" + }, + "skip_existing": { + "description": "Skip importing existing order data.", + "type": "boolean" + } }, "type": "object" } @@ -25328,7 +40985,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25339,8 +41002,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "days": { "description": "Number of days to import.", "type": "integer" }, - "skip_existing": { "description": "Skip importing existing order data.", "type": "boolean" } + "days": { + "description": "Number of days to import.", + "type": "integer" + }, + "skip_existing": { + "description": "Skip importing existing order data.", + "type": "boolean" + } }, "type": "object" } @@ -25349,7 +41018,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25360,8 +41035,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "days": { "description": "Number of days to import.", "type": "integer" }, - "skip_existing": { "description": "Skip importing existing order data.", "type": "boolean" } + "days": { + "description": "Number of days to import.", + "type": "integer" + }, + "skip_existing": { + "description": "Skip importing existing order data.", + "type": "boolean" + } }, "type": "object" } @@ -25370,7 +41051,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25380,7 +41067,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25388,7 +41081,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25396,7 +41095,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25406,7 +41111,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25414,7 +41125,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25422,7 +41139,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25432,7 +41155,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25446,7 +41175,9 @@ "in": "query", "name": "days", "required": false, - "schema": { "minimum": 0 } + "schema": { + "minimum": 0 + } }, { "description": "Skip importing existing order data.", @@ -25458,7 +41189,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25472,105 +41209,162 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "num_items_sold", "net_total"] } + "schema": { + "enum": [ + "date", + "net_total", + "num_items_sold" + ] + } }, { "description": "Limit result set to items that have the specified product(s) assigned.", "in": "query", "name": "product_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified product(s) assigned.", "in": "query", "name": "product_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified variation(s) assigned.", "in": "query", "name": "variation_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified variation(s) assigned.", "in": "query", "name": "variation_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified coupon(s) assigned.", "in": "query", "name": "coupon_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified coupon(s) assigned.", "in": "query", "name": "coupon_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified tax rate(s) assigned.", "in": "query", "name": "tax_rate_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", "in": "query", "name": "tax_rate_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified order status.", @@ -25581,15 +41375,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -25604,15 +41398,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -25623,14 +41417,28 @@ "in": "query", "name": "customer_type", "required": false, - "schema": { "enum": ["", "returning", "new"] } + "schema": { + "enum": [ + "", + "new", + "returning" + ] + } }, { "description": "Limit result set to specific types of refunds.", "in": "query", "name": "refunds", "required": false, - "schema": { "enum": ["", "all", "partial", "full", "none"] } + "schema": { + "enum": [ + "", + "all", + "full", + "none", + "partial" + ] + } }, { "description": "Add additional piece of info about each coupon to the report.", @@ -25644,28 +41452,44 @@ "in": "query", "name": "order_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified order IDs.", "in": "query", "name": "order_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to orders that include products with the specified attributes.", "in": "query", "name": "attribute_is", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Limit result set to orders that don't include products with the specified attributes.", "in": "query", "name": "attribute_is_not", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25677,7 +41501,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders" + } + } + }, "description": "OK" } } @@ -25691,63 +41521,103 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "net_revenue", "orders_count", "avg_order_value"] } + "schema": { + "enum": [ + "avg_order_value", + "date", + "net_revenue", + "orders_count" + ] + } }, { "description": "Time interval to use for buckets in the returned data.", "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit result set to items that have the specified order status.", @@ -25758,15 +41628,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -25781,15 +41651,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -25800,105 +41670,175 @@ "in": "query", "name": "product_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified product(s) assigned.", "in": "query", "name": "product_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified variation(s) assigned.", "in": "query", "name": "variation_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified variation(s) assigned.", "in": "query", "name": "variation_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified coupon(s) assigned.", "in": "query", "name": "coupon_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified coupon(s) assigned.", "in": "query", "name": "coupon_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified tax rate(s) assigned.", "in": "query", "name": "tax_rate_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", "in": "query", "name": "tax_rate_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Alias for customer_type (deprecated).", "in": "query", "name": "customer", "required": false, - "schema": { "enum": ["new", "returning"] } + "schema": { + "enum": [ + "new", + "returning" + ] + } }, { "description": "Limit result set to orders that have the specified customer_type", "in": "query", "name": "customer_type", "required": false, - "schema": { "enum": ["new", "returning"] } + "schema": { + "enum": [ + "new", + "returning" + ] + } }, { "description": "Limit result set to specific types of refunds.", "in": "query", "name": "refunds", "required": false, - "schema": { "enum": ["", "all", "partial", "full", "none"] } + "schema": { + "enum": [ + "", + "all", + "full", + "none", + "partial" + ] + } }, { "description": "Limit result set to orders that include products with the specified attributes.", "in": "query", "name": "attribute_is", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Limit result set to orders that don't include products with the specified attributes.", "in": "query", "name": "attribute_is_not", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "category", "variation", "coupon", "customer_type"] } + "schema": { + "enum": [ + "category", + "coupon", + "customer_type", + "product", + "variation" + ] + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25910,7 +41850,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders_stats" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders_stats" + } + } + }, "description": "OK" } } @@ -25924,7 +41870,12 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.", @@ -25934,21 +41885,21 @@ "schema": { "items": { "enum": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "type": "string" } @@ -25959,20 +41910,28 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_performance_indicator" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_performance_indicator" + } + } }, "description": "OK" } @@ -25987,7 +41946,12 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.", @@ -25997,21 +41961,21 @@ "schema": { "items": { "enum": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "type": "string" } @@ -26022,20 +41986,28 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_performance_indicator" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_performance_indicator" + } + } }, "description": "OK" } @@ -26050,42 +42022,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26093,7 +42084,15 @@ "name": "orderby", "required": false, "schema": { - "enum": ["date", "net_revenue", "orders_count", "items_sold", "product_name", "variations", "sku"] + "enum": [ + "date", + "items_sold", + "net_revenue", + "orders_count", + "product_name", + "sku", + "variations" + ] } }, { @@ -26108,21 +42107,34 @@ "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit result to items with specified product IDs.", "in": "query", "name": "products", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Add additional piece of info about each product to the report.", @@ -26134,7 +42146,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_products" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_products" + } + } + }, "description": "OK" } } @@ -26148,42 +42166,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26192,15 +42229,15 @@ "required": false, "schema": { "enum": [ - "date", - "net_revenue", "coupons", - "refunds", - "shipping", - "taxes", + "date", + "items_sold", + "net_revenue", "net_revenue", "orders_count", - "items_sold" + "refunds", + "shipping", + "taxes" ] } }, @@ -26216,48 +42253,83 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Limit result to items from the specified categories.", "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result to items with specified product IDs.", "in": "query", "name": "products", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result to items with specified variation IDs.", "in": "query", "name": "variations", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "category", "variation"] } + "schema": { + "enum": [ + "category", + "product", + "variation" + ] + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_products_stats" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_products_stats" + } + } }, "description": "OK" } @@ -26272,42 +42344,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26316,16 +42407,16 @@ "required": false, "schema": { "enum": [ - "date", - "total_sales", "coupons", + "date", + "gross_sales", + "items_sold", + "net_revenue", + "orders_count", "refunds", "shipping", "taxes", - "net_revenue", - "orders_count", - "items_sold", - "gross_sales" + "total_sales" ] } }, @@ -26341,26 +42432,55 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "category", "variation", "coupon", "customer_type"] } + "schema": { + "enum": [ + "category", + "coupon", + "customer_type", + "product", + "variation" + ] + } }, { "description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.", "in": "query", "name": "date_type", "required": false, - "schema": { "enum": ["date_paid", "date_created", "date_completed"] } + "schema": { + "enum": [ + "date_completed", + "date_created", + "date_paid" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_revenue_stats" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_revenue_stats" + } + } + }, "description": "OK" } } @@ -26374,49 +42494,82 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["stock_status", "stock_quantity", "date", "id", "include", "title", "sku"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "sku", + "stock_quantity", + "stock_status", + "title" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -26430,26 +42583,48 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items assigned a stock report type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["all", "lowstock", "instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "all", + "instock", + "lowstock", + "onbackorder", + "outofstock" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_stock" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_stock" + } + } + }, "description": "OK" } } @@ -26463,13 +42638,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customers_stats" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers_stats" + } + } }, "description": "OK" } @@ -26484,42 +42668,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26529,13 +42732,13 @@ "schema": { "enum": [ "name", - "tax_rate_id", - "tax_code", - "rate", "order_tax", - "total_tax", + "orders_count", + "rate", "shipping_tax", - "orders_count" + "tax_code", + "tax_rate_id", + "total_tax" ] } }, @@ -26551,12 +42754,22 @@ "in": "query", "name": "taxes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_taxes" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_taxes" + } + } + }, "description": "OK" } } @@ -26570,276 +42783,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "description": "Sort collection by object attribute.", - "in": "query", - "name": "orderby", - "required": false, - "schema": { "enum": ["date", "items_sold", "total_sales", "orders_count", "products_count"] } - }, - { - "description": "Force retrieval of fresh data instead of from the cache.", - "in": "query", - "name": "force_cache_refresh", - "required": false, - "schema": {} - }, - { - "description": "Time interval to use for buckets in the returned data.", - "in": "query", - "name": "interval", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", - "in": "query", - "name": "taxes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Segment the response by additional constraint.", - "in": "query", - "name": "segmentby", - "required": false, - "schema": { "enum": ["tax_rate_id"] } - }, - { - "description": "Limit stats fields to the specified items.", - "in": "query", - "name": "fields", - "required": false, - "schema": { "items": { "type": "string" } } - } - ], - "responses": { - "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_taxes_stats" } } }, - "description": "OK" - } - } - } - }, - "/wc-analytics/reports/variations": { - "get": { - "parameters": [ - { - "description": "Scope under which the request is made; determines fields present in response.", - "in": "query", - "name": "context", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "description": "Current page of the collection.", - "in": "query", - "name": "page", - "required": false, - "schema": { "minimum": 1 } - }, - { - "description": "Maximum number of items to be returned in result set.", - "in": "query", - "name": "per_page", - "required": false, - "schema": { "maximum": 100, "minimum": 1 } - }, - { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "in": "query", - "name": "after", - "required": false, - "schema": { "format": "date-time" } - }, - { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "in": "query", - "name": "before", - "required": false, - "schema": { "format": "date-time" } - }, - { - "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "in": "query", - "name": "match", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "description": "Order sort attribute ascending or descending.", - "in": "query", - "name": "order", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "description": "Sort collection by object attribute.", - "in": "query", - "name": "orderby", - "required": false, - "schema": { "enum": ["date", "net_revenue", "orders_count", "items_sold", "sku"] } - }, - { - "description": "Limit result set to items that have the specified parent product(s).", - "in": "query", - "name": "product_includes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to items that don't have the specified parent product(s).", - "in": "query", - "name": "product_excludes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result to items with specified variation IDs.", - "in": "query", - "name": "variations", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Add additional piece of info about each variation to the report.", - "in": "query", - "name": "extended_info", - "required": false, - "schema": {} - }, - { - "description": "Limit result set to variations that include the specified attributes.", - "in": "query", - "name": "attribute_is", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "description": "Limit result set to variations that don't include the specified attributes.", - "in": "query", - "name": "attribute_is_not", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "description": "Limit result set to variations in the specified categories.", - "in": "query", - "name": "category_includes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to variations not in the specified categories.", - "in": "query", - "name": "category_excludes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Force retrieval of fresh data instead of from the cache.", - "in": "query", - "name": "force_cache_refresh", - "required": false, - "schema": {} - }, - { - "description": "Limit result to items with specified product IDs.", - "in": "query", - "name": "products", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ], - "responses": { - "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_varitations" } } }, - "description": "OK" - } - } - } - }, - "/wc-analytics/reports/variations/stats": { - "get": { - "parameters": [ - { - "description": "Scope under which the request is made; determines fields present in response.", - "in": "query", - "name": "context", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "description": "Current page of the collection.", - "in": "query", - "name": "page", - "required": false, - "schema": { "minimum": 1 } - }, - { - "description": "Maximum number of items to be returned in result set.", - "in": "query", - "name": "per_page", - "required": false, - "schema": { "maximum": 100, "minimum": 1 } - }, - { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "in": "query", - "name": "after", - "required": false, - "schema": { "format": "date-time" } - }, - { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "in": "query", - "name": "before", - "required": false, - "schema": { "format": "date-time" } - }, - { - "description": "Order sort attribute ascending or descending.", - "in": "query", - "name": "order", - "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26849,14 +42847,10 @@ "schema": { "enum": [ "date", - "net_revenue", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", + "items_sold", "orders_count", - "items_sold" + "products_count", + "total_sales" ] } }, @@ -26872,83 +42866,501 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { - "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", + "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", "in": "query", - "name": "match", + "name": "taxes", "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "description": "Limit result to items from the specified categories.", - "in": "query", - "name": "category_includes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to variations not in the specified categories.", - "in": "query", - "name": "category_excludes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to items that have the specified parent product(s).", - "in": "query", - "name": "product_includes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to items that don't have the specified parent product(s).", - "in": "query", - "name": "product_excludes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result to items with specified variation IDs.", - "in": "query", - "name": "variations", - "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "category", "variation"] } + "schema": { + "enum": [ + "tax_rate_id" + ] + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_taxes_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/variations": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + }, + { + "description": "Current page of the collection.", + "in": "query", + "name": "page", + "required": false, + "schema": { + "minimum": 1 + } + }, + { + "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 1 + } + }, + { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", + "in": "query", + "name": "match", + "required": false, + "schema": { + "enum": [ + "all", + "any" + ] + } + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by object attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "date", + "items_sold", + "net_revenue", + "orders_count", + "sku" + ] + } + }, + { + "description": "Limit result set to items that have the specified parent product(s).", + "in": "query", + "name": "product_includes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to items that don't have the specified parent product(s).", + "in": "query", + "name": "product_excludes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result to items with specified variation IDs.", + "in": "query", + "name": "variations", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Add additional piece of info about each variation to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to variations that include the specified attributes.", + "in": "query", + "name": "attribute_is", + "required": false, + "schema": { + "items": { + "type": "array" + } + } + }, + { + "description": "Limit result set to variations that don't include the specified attributes.", + "in": "query", + "name": "attribute_is_not", + "required": false, + "schema": { + "items": { + "type": "array" + } + } + }, + { + "description": "Limit result set to variations in the specified categories.", + "in": "query", + "name": "category_includes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to variations not in the specified categories.", + "in": "query", + "name": "category_excludes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "description": "Limit result to items with specified product IDs.", + "in": "query", + "name": "products", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_varitations" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/variations/stats": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + }, + { + "description": "Current page of the collection.", + "in": "query", + "name": "page", + "required": false, + "schema": { + "minimum": 1 + } + }, + { + "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 1 + } + }, + { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by object attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "coupons", + "date", + "items_sold", + "net_revenue", + "net_revenue", + "orders_count", + "refunds", + "shipping", + "taxes" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "description": "Time interval to use for buckets in the returned data.", + "in": "query", + "name": "interval", + "required": false, + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } + }, + { + "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", + "in": "query", + "name": "match", + "required": false, + "schema": { + "enum": [ + "all", + "any" + ] + } + }, + { + "description": "Limit result to items from the specified categories.", + "in": "query", + "name": "category_includes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to variations not in the specified categories.", + "in": "query", + "name": "category_excludes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to items that have the specified parent product(s).", + "in": "query", + "name": "product_includes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to items that don't have the specified parent product(s).", + "in": "query", + "name": "product_excludes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result to items with specified variation IDs.", + "in": "query", + "name": "variations", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Segment the response by additional constraint.", + "in": "query", + "name": "segmentby", + "required": false, + "schema": { + "enum": [ + "category", + "product", + "variation" + ] + } + }, + { + "description": "Limit stats fields to the specified items.", + "in": "query", + "name": "fields", + "required": false, + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to orders that include products with the specified attributes.", "in": "query", "name": "attribute_is", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Limit result set to orders that don't include products with the specified attributes.", "in": "query", "name": "attribute_is_not", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_variations_stats" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_variations_stats" + } + } }, "description": "OK" } @@ -26957,7 +43369,15 @@ }, "/wc-analytics/reports/{type}/export": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "type", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26967,7 +43387,10 @@ "description": "When true, email a link to download the export to the requesting user.", "type": "boolean" }, - "report_args": { "description": "Parameters to pass on to the exported report.", "type": "object" } + "report_args": { + "description": "Parameters to pass on to the exported report.", + "type": "object" + } }, "type": "object" } @@ -26976,13 +43399,27 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "type", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26992,7 +43429,10 @@ "description": "When true, email a link to download the export to the requesting user.", "type": "boolean" }, - "report_args": { "description": "Parameters to pass on to the exported report.", "type": "object" } + "report_args": { + "description": "Parameters to pass on to the exported report.", + "type": "object" + } }, "type": "object" } @@ -27001,13 +43441,27 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "type", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27017,7 +43471,10 @@ "description": "When true, email a link to download the export to the requesting user.", "type": "boolean" }, - "report_args": { "description": "Parameters to pass on to the exported report.", "type": "object" } + "report_args": { + "description": "Parameters to pass on to the exported report.", + "type": "object" + } }, "type": "object" } @@ -27026,7 +43483,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, "description": "OK" } } @@ -27035,12 +43498,30 @@ "/wc-analytics/reports/{type}/export/{export_id}/status": { "get": { "parameters": [ - { "description": "", "in": "path", "name": "type", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "export_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "export_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export_status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export_status" + } + } + }, "description": "OK" } } @@ -27049,12 +43530,30 @@ "/wc-analytics/settings/{group_id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27062,16 +43561,35 @@ }, "/wc-analytics/settings/{group_id}/batch": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27081,22 +43599,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27106,22 +43649,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27131,7 +43699,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -27140,7 +43714,13 @@ "/wc-analytics/settings/{group_id}/{id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -27148,11 +43728,23 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27166,17 +43758,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27186,7 +43795,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27200,17 +43815,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27220,7 +43852,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27234,17 +43872,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27254,7 +43909,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27268,21 +43929,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -27296,21 +43967,38 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { "description": "Sort by tax class.", "in": "query", "name": "class", "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } }, { "description": "Search by similar tax code.", @@ -27324,12 +44012,22 @@ "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27340,16 +44038,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27358,13 +44074,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27373,7 +44098,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27386,16 +44117,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27404,13 +44153,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27419,7 +44177,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -27430,16 +44194,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27448,13 +44230,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27463,7 +44254,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -27474,16 +44271,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27492,13 +44307,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27507,7 +44331,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -27541,7 +44371,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27560,12 +44396,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27585,16 +44432,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27603,13 +44468,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27618,7 +44492,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27638,16 +44518,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27656,13 +44554,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27671,7 +44578,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27691,16 +44604,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27709,13 +44640,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27724,7 +44664,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27738,21 +44684,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Search by similar product name, SKU, or attribute value.", @@ -27766,28 +44722,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -27801,14 +44765,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -27822,28 +44794,51 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -27857,7 +44852,17 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -27892,21 +44897,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit result set to products with or without price.", @@ -27923,9 +44942,18 @@ "schema": { "items": { "properties": { - "attribute": { "description": "Attribute slug.", "type": "string" }, - "term": { "description": "Attribute term.", "type": "string" }, - "terms": { "description": "Attribute terms.", "type": "array" } + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } }, "type": "object" } @@ -27934,7 +44962,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -27943,10 +44977,26 @@ "/wc-telemetry": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-telemetry/tracker": { @@ -27961,25 +45011,56 @@ "required": false, "type": "string" }, - "platform": { "description": "Platform to track.", "required": true, "type": "string" }, - "version": { "description": "Platform version to track.", "required": true, "type": "string" } + "platform": { + "description": "Platform to track.", + "required": true, + "type": "string" + }, + "version": { + "description": "Platform version to track.", + "required": true, + "type": "string" + } }, - "required": ["platform", "version"], + "required": [ + "platform", + "version" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/private": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/private/ai/business-description": { @@ -28002,7 +45083,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/ai/business-description" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/business-description" + } + } }, "description": "OK" } @@ -28028,7 +45113,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/images" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/images" + } + } + }, "description": "OK" } } @@ -28038,7 +45129,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/patterns" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/patterns" + } + } + }, "description": "OK" } } @@ -28053,7 +45150,10 @@ "description": "The business description for a given store.", "type": "string" }, - "images": { "description": "The images for a given store.", "type": "object" } + "images": { + "description": "The images for a given store.", + "type": "object" + } }, "type": "object" } @@ -28062,7 +45162,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/patterns" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/patterns" + } + } + }, "description": "OK" } } @@ -28091,7 +45197,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/product" + } + } + }, "description": "OK" } } @@ -28101,7 +45213,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/products" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/products" + } + } + }, "description": "OK" } } @@ -28116,7 +45234,10 @@ "description": "The business description for a given store.", "type": "string" }, - "images": { "description": "The images for a given store.", "type": "object" } + "images": { + "description": "The images for a given store.", + "type": "object" + } }, "type": "object" } @@ -28125,7 +45246,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/products" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/products" + } + } + }, "description": "OK" } } @@ -28135,7 +45262,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/store-info" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/store-info" + } + } + }, "description": "OK" } } @@ -28160,7 +45293,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/store-title" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/store-title" + } + } + }, "description": "OK" } } @@ -28170,7 +45309,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patterns" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/patterns" + } + } + }, "description": "OK" } } @@ -28178,7 +45323,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patterns" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/patterns" + } + } + }, "description": "OK" } } @@ -28187,10 +45338,26 @@ "/wc/store": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/store/batch": { @@ -28199,14 +45366,28 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "requests": { "required": true, "type": "array" }, "validation": { "type": "string" } }, - "required": ["requests"], + "properties": { + "requests": { + "required": true, + "type": "array" + }, + "validation": { + "type": "string" + } + }, + "required": [ + "requests" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/store/cart": { @@ -28217,12 +45398,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28235,9 +45427,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "id": { "description": "The basket item product or variation ID.", "type": "integer" }, - "quantity": { "description": "Quantity of this item to add to the basket.", "type": "integer" }, - "variation": { "description": "Chosen attributes (for variations).", "type": "array" } + "id": { + "description": "The basket item product or variation ID.", + "type": "integer" + }, + "quantity": { + "description": "Quantity of this item to add to the basket.", + "type": "integer" + }, + "variation": { + "description": "Chosen attributes (for variations).", + "type": "array" + } }, "type": "object" } @@ -28246,7 +45447,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28259,7 +45466,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string" } + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } }, "type": "object" } @@ -28268,7 +45478,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28278,7 +45494,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28290,12 +45512,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28306,7 +45539,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "The coupon's unique code.", "type": "string" }, + "code": { + "description": "The coupon's unique code.", + "type": "string" + }, "discount_type": { "description": "The discount type for the coupon (eg percentage or fixed amount)", "type": "string" @@ -28319,7 +45555,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28338,7 +45580,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28357,12 +45605,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28375,7 +45634,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "data": { "description": "Additional data to pass to the extension", "type": "object" }, + "data": { + "description": "Additional data to pass to the extension", + "type": "object" + }, "namespace": { "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", "type": "string" @@ -28388,7 +45650,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart-extensions" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart-extensions" + } + } + }, "description": "OK" } } @@ -28398,7 +45666,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28410,12 +45684,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28424,13 +45709,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28449,7 +45747,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28468,12 +45772,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28491,13 +45806,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28515,13 +45843,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28539,13 +45880,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28558,7 +45912,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string" } + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } }, "type": "object" } @@ -28567,7 +45924,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28580,7 +45943,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "key": { "description": "Unique identifier (key) for the basket item.", "type": "string" } + "key": { + "description": "Unique identifier (key) for the basket item.", + "type": "string" + } }, "type": "object" } @@ -28589,7 +45955,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28605,7 +45977,11 @@ "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "required": false, - "type": ["integer", "string", "null"] + "type": [ + "integer", + "null", + "string" + ] }, "rate_id": { "description": "The chosen rate ID for the package.", @@ -28613,7 +45989,9 @@ "type": "string" } }, - "required": ["rate_id"], + "required": [ + "rate_id" + ], "type": "object" } } @@ -28621,7 +45999,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28634,8 +46018,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing_address": { "description": "Billing address.", "type": "object" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "billing_address": { + "description": "Billing address.", + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, "type": "object" } @@ -28644,7 +46034,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28657,8 +46053,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "key": { "description": "Unique identifier (key) for the basket item to update.", "type": "string" }, - "quantity": { "description": "New quantity of the item in the basket.", "type": "integer" } + "key": { + "description": "Unique identifier (key) for the basket item to update.", + "type": "string" + }, + "quantity": { + "description": "New quantity of the item in the basket.", + "type": "integer" + } }, "type": "object" } @@ -28667,7 +46069,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28681,12 +46089,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, "description": "OK" } } @@ -28701,7 +46120,11 @@ "description": "Additional fields to be persisted on the order.", "type": "object" }, - "billing_address": { "description": "Billing address.", "required": true, "type": "object" }, + "billing_address": { + "description": "Billing address.", + "required": true, + "type": "object" + }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "type": "boolean" @@ -28714,7 +46137,9 @@ "description": "Customer password for new accounts, if applicable.", "type": "string" }, - "extensions": { "type": "object" }, + "extensions": { + "type": "object" + }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array" @@ -28723,9 +46148,14 @@ "description": "The ID of the payment method being used to process the payment.", "type": "string" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, - "required": ["billing_address"], + "required": [ + "billing_address" + ], "type": "object" } } @@ -28733,7 +46163,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, "description": "OK" } } @@ -28741,7 +46177,15 @@ }, "/wc/store/checkout/{id}": { "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28751,12 +46195,18 @@ "description": "Additional fields to be persisted on the order.", "type": "object" }, - "billing_address": { "description": "Billing address.", "required": true, "type": "object" }, + "billing_address": { + "description": "Billing address.", + "required": true, + "type": "object" + }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string" }, - "extensions": { "type": "object" }, + "extensions": { + "type": "object" + }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array" @@ -28765,9 +46215,14 @@ "description": "The ID of the payment method being used to process the payment.", "type": "string" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, - "required": ["billing_address"], + "required": [ + "billing_address" + ], "type": "object" } } @@ -28775,7 +46230,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout-order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout-order" + } + } + }, "description": "OK" } } @@ -28789,13 +46250,30 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order" + } + } + }, "description": "OK" } } @@ -28809,21 +46287,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -28844,35 +46332,54 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources created before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "When limiting response using after/before, which date column to compare against.", "in": "query", "name": "date_column", "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -28886,7 +46393,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -28895,17 +46407,17 @@ "required": false, "schema": { "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ] } }, @@ -28914,21 +46426,37 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -28956,7 +46484,13 @@ "in": "query", "name": "category_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products assigned a specific tag ID.", @@ -28970,7 +46504,13 @@ "in": "query", "name": "tag_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products on sale.", @@ -29000,7 +46540,11 @@ "required": false, "schema": { "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -29022,18 +46566,26 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "sanitize_callback": "wp_parse_id_list", "type": "array" } @@ -29047,26 +46599,56 @@ "in": "query", "name": "attribute_relation", "required": false, - "schema": { "enum": ["in", "and"] } + "schema": { + "enum": [ + "and", + "in" + ] + } }, { "description": "Determines if hidden or visible catalogue products are shown.", "in": "query", "name": "catalog_visibility", "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } + "schema": { + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ] + } }, { "description": "Limit result set to products with a certain average rating.", "in": "query", "name": "rating", "required": false, - "schema": { "items": { "enum": [1, 2, 3, 4, 5], "type": "integer" } } + "schema": { + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -29080,12 +46662,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -29106,21 +46699,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -29134,28 +46737,50 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count", "menu_order", "name_num", "id"] } + "schema": { + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -29167,7 +46792,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, "description": "OK" } } @@ -29188,12 +46819,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -29207,21 +46849,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -29235,28 +46888,47 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count"] } + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -29268,7 +46940,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, "description": "OK" } } @@ -29289,12 +46967,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, "description": "OK" } } @@ -29308,21 +46998,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -29343,35 +47043,54 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources created before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "When limiting response using after/before, which date column to compare against.", "in": "query", "name": "date_column", "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -29385,7 +47104,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -29394,17 +47118,17 @@ "required": false, "schema": { "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ] } }, @@ -29413,21 +47137,37 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -29455,7 +47195,13 @@ "in": "query", "name": "category_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products assigned a specific tag ID.", @@ -29469,7 +47215,13 @@ "in": "query", "name": "tag_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products on sale.", @@ -29499,7 +47251,11 @@ "required": false, "schema": { "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -29521,18 +47277,26 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "sanitize_callback": "wp_parse_id_list", "type": "array" } @@ -29546,21 +47310,45 @@ "in": "query", "name": "attribute_relation", "required": false, - "schema": { "enum": ["in", "and"] } + "schema": { + "enum": [ + "and", + "in" + ] + } }, { "description": "Determines if hidden or visible catalogue products are shown.", "in": "query", "name": "catalog_visibility", "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } + "schema": { + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ] + } }, { "description": "Limit result set to products with a certain average rating.", "in": "query", "name": "rating", "required": false, - "schema": { "items": { "enum": [1, 2, 3, 4, 5], "type": "integer" } } + "schema": { + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + } + } }, { "description": "If true, calculates the minimum and maximum product prices for the collection.", @@ -29585,14 +47373,23 @@ "items": { "properties": { "query_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "enum": ["and", "or"], + "enum": [ + "and", + "or" + ], "readonly": true, "type": "string" }, "taxonomy": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxonomy name.", "readonly": true, "type": "string" @@ -29613,7 +47410,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product-collection-data" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-collection-data" + } + } }, "description": "OK" } @@ -29628,21 +47429,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Offset the result set by a specific number of items.", @@ -29656,14 +47467,27 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "rating", "product"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "product", + "rating" + ] + } }, { "description": "Limit result set to reviews from specific category IDs.", @@ -29682,7 +47506,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -29696,21 +47526,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -29724,28 +47564,47 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count"] } + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -29757,7 +47616,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, "description": "OK" } } @@ -29778,12 +47643,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -29792,18 +47668,35 @@ "/wc/store/products/{slug}": { "get": { "parameters": [ - { "description": "Slug of the resource.", "in": "path", "name": "slug", "required": true, "schema": {} }, + { + "description": "Slug of the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -29812,10 +47705,26 @@ "/wc/store/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/store/v1/batch": { @@ -29824,14 +47733,28 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "requests": { "required": true, "type": "array" }, "validation": { "type": "string" } }, - "required": ["requests"], + "properties": { + "requests": { + "required": true, + "type": "array" + }, + "validation": { + "type": "string" + } + }, + "required": [ + "requests" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/store/v1/cart": { @@ -29842,12 +47765,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -29860,9 +47794,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "id": { "description": "The basket item product or variation ID.", "type": "integer" }, - "quantity": { "description": "Quantity of this item to add to the basket.", "type": "integer" }, - "variation": { "description": "Chosen attributes (for variations).", "type": "array" } + "id": { + "description": "The basket item product or variation ID.", + "type": "integer" + }, + "quantity": { + "description": "Quantity of this item to add to the basket.", + "type": "integer" + }, + "variation": { + "description": "Chosen attributes (for variations).", + "type": "array" + } }, "type": "object" } @@ -29871,7 +47814,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -29884,7 +47833,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string" } + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } }, "type": "object" } @@ -29893,7 +47845,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -29903,7 +47861,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -29915,12 +47879,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -29931,7 +47906,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "The coupon's unique code.", "type": "string" }, + "code": { + "description": "The coupon's unique code.", + "type": "string" + }, "discount_type": { "description": "The discount type for the coupon (eg percentage or fixed amount)", "type": "string" @@ -29944,7 +47922,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -29963,7 +47947,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -29982,12 +47972,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -30000,7 +48001,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "data": { "description": "Additional data to pass to the extension", "type": "object" }, + "data": { + "description": "Additional data to pass to the extension", + "type": "object" + }, "namespace": { "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", "type": "string" @@ -30013,7 +48017,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart-extensions" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart-extensions" + } + } + }, "description": "OK" } } @@ -30023,7 +48033,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30035,12 +48051,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30049,13 +48076,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30074,7 +48114,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30093,12 +48139,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30116,13 +48173,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30140,13 +48210,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30164,13 +48247,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30183,7 +48279,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string" } + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } }, "type": "object" } @@ -30192,7 +48291,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30205,7 +48310,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "key": { "description": "Unique identifier (key) for the basket item.", "type": "string" } + "key": { + "description": "Unique identifier (key) for the basket item.", + "type": "string" + } }, "type": "object" } @@ -30214,7 +48322,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30230,7 +48344,11 @@ "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "required": false, - "type": ["integer", "string", "null"] + "type": [ + "integer", + "null", + "string" + ] }, "rate_id": { "description": "The chosen rate ID for the package.", @@ -30238,7 +48356,9 @@ "type": "string" } }, - "required": ["rate_id"], + "required": [ + "rate_id" + ], "type": "object" } } @@ -30246,7 +48366,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30259,8 +48385,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing_address": { "description": "Billing address.", "type": "object" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "billing_address": { + "description": "Billing address.", + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, "type": "object" } @@ -30269,7 +48401,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30282,8 +48420,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "key": { "description": "Unique identifier (key) for the basket item to update.", "type": "string" }, - "quantity": { "description": "New quantity of the item in the basket.", "type": "integer" } + "key": { + "description": "Unique identifier (key) for the basket item to update.", + "type": "string" + }, + "quantity": { + "description": "New quantity of the item in the basket.", + "type": "integer" + } }, "type": "object" } @@ -30292,7 +48436,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30306,12 +48456,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, "description": "OK" } } @@ -30326,7 +48487,11 @@ "description": "Additional fields to be persisted on the order.", "type": "object" }, - "billing_address": { "description": "Billing address.", "required": true, "type": "object" }, + "billing_address": { + "description": "Billing address.", + "required": true, + "type": "object" + }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "type": "boolean" @@ -30339,7 +48504,9 @@ "description": "Customer password for new accounts, if applicable.", "type": "string" }, - "extensions": { "type": "object" }, + "extensions": { + "type": "object" + }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array" @@ -30348,9 +48515,14 @@ "description": "The ID of the payment method being used to process the payment.", "type": "string" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, - "required": ["billing_address"], + "required": [ + "billing_address" + ], "type": "object" } } @@ -30358,7 +48530,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, "description": "OK" } } @@ -30366,7 +48544,15 @@ }, "/wc/store/v1/checkout/{id}": { "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30376,12 +48562,18 @@ "description": "Additional fields to be persisted on the order.", "type": "object" }, - "billing_address": { "description": "Billing address.", "required": true, "type": "object" }, + "billing_address": { + "description": "Billing address.", + "required": true, + "type": "object" + }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string" }, - "extensions": { "type": "object" }, + "extensions": { + "type": "object" + }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array" @@ -30390,9 +48582,14 @@ "description": "The ID of the payment method being used to process the payment.", "type": "string" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, - "required": ["billing_address"], + "required": [ + "billing_address" + ], "type": "object" } } @@ -30400,7 +48597,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout-order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout-order" + } + } + }, "description": "OK" } } @@ -30414,13 +48617,30 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order" + } + } + }, "description": "OK" } } @@ -30434,21 +48654,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -30469,35 +48699,54 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources created before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "When limiting response using after/before, which date column to compare against.", "in": "query", "name": "date_column", "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -30511,7 +48760,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -30520,17 +48774,17 @@ "required": false, "schema": { "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ] } }, @@ -30539,21 +48793,37 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -30581,7 +48851,13 @@ "in": "query", "name": "category_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products assigned a specific tag ID.", @@ -30595,7 +48871,13 @@ "in": "query", "name": "tag_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products on sale.", @@ -30625,7 +48907,11 @@ "required": false, "schema": { "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -30647,18 +48933,26 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "sanitize_callback": "wp_parse_id_list", "type": "array" } @@ -30672,26 +48966,56 @@ "in": "query", "name": "attribute_relation", "required": false, - "schema": { "enum": ["in", "and"] } + "schema": { + "enum": [ + "and", + "in" + ] + } }, { "description": "Determines if hidden or visible catalogue products are shown.", "in": "query", "name": "catalog_visibility", "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } + "schema": { + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ] + } }, { "description": "Limit result set to products with a certain average rating.", "in": "query", "name": "rating", "required": false, - "schema": { "items": { "enum": [1, 2, 3, 4, 5], "type": "integer" } } + "schema": { + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -30705,12 +49029,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -30731,21 +49066,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -30759,28 +49104,50 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count", "menu_order", "name_num", "id"] } + "schema": { + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -30792,7 +49159,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, "description": "OK" } } @@ -30813,12 +49186,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -30832,21 +49216,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -30860,28 +49255,47 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count"] } + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -30893,7 +49307,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, "description": "OK" } } @@ -30914,12 +49334,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, "description": "OK" } } @@ -30933,21 +49365,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -30968,35 +49410,54 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources created before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "When limiting response using after/before, which date column to compare against.", "in": "query", "name": "date_column", "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -31010,7 +49471,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -31019,17 +49485,17 @@ "required": false, "schema": { "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ] } }, @@ -31038,21 +49504,37 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -31080,7 +49562,13 @@ "in": "query", "name": "category_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products assigned a specific tag ID.", @@ -31094,7 +49582,13 @@ "in": "query", "name": "tag_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products on sale.", @@ -31124,7 +49618,11 @@ "required": false, "schema": { "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -31146,18 +49644,26 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "sanitize_callback": "wp_parse_id_list", "type": "array" } @@ -31171,21 +49677,45 @@ "in": "query", "name": "attribute_relation", "required": false, - "schema": { "enum": ["in", "and"] } + "schema": { + "enum": [ + "and", + "in" + ] + } }, { "description": "Determines if hidden or visible catalogue products are shown.", "in": "query", "name": "catalog_visibility", "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } + "schema": { + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ] + } }, { "description": "Limit result set to products with a certain average rating.", "in": "query", "name": "rating", "required": false, - "schema": { "items": { "enum": [1, 2, 3, 4, 5], "type": "integer" } } + "schema": { + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + } + } }, { "description": "If true, calculates the minimum and maximum product prices for the collection.", @@ -31210,14 +49740,23 @@ "items": { "properties": { "query_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "enum": ["and", "or"], + "enum": [ + "and", + "or" + ], "readonly": true, "type": "string" }, "taxonomy": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxonomy name.", "readonly": true, "type": "string" @@ -31238,7 +49777,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product-collection-data" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-collection-data" + } + } }, "description": "OK" } @@ -31253,21 +49796,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Offset the result set by a specific number of items.", @@ -31281,14 +49834,27 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "rating", "product"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "product", + "rating" + ] + } }, { "description": "Limit result set to reviews from specific category IDs.", @@ -31307,7 +49873,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -31321,21 +49893,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -31349,28 +49931,47 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count"] } + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -31382,7 +49983,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, "description": "OK" } } @@ -31403,12 +50010,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -31417,18 +50035,35 @@ "/wc/store/v1/products/{slug}": { "get": { "parameters": [ - { "description": "Slug of the resource.", "in": "path", "name": "slug", "required": true, "schema": {} }, + { + "description": "Slug of the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -31437,10 +50072,26 @@ "/wc/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v1/coupons": { @@ -31451,21 +50102,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -31479,28 +50140,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -31514,14 +50187,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", @@ -31540,7 +50227,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -31555,8 +50248,15 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "required": true, "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31577,7 +50277,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31602,7 +50308,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -31612,7 +50321,9 @@ "type": "integer" } }, - "required": ["code"], + "required": [ + "code" + ], "type": "object" } } @@ -31620,7 +50331,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -31637,8 +50354,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31659,7 +50382,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31684,7 +50413,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -31701,7 +50433,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -31716,8 +50454,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31738,7 +50482,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31763,7 +50513,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -31780,7 +50533,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -31795,8 +50554,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31817,7 +50582,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31842,7 +50613,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -31859,7 +50633,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -31881,7 +50661,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -31890,7 +50673,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -31909,12 +50698,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -31938,8 +50738,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31960,7 +50766,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31985,7 +50797,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -32002,7 +50817,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -32026,8 +50847,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -32048,7 +50875,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -32073,7 +50906,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -32090,7 +50926,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -32114,8 +50956,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -32136,7 +50984,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -32161,7 +51015,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -32178,7 +51035,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -32192,21 +51055,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -32220,14 +51093,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -32241,21 +51122,35 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } + "schema": { + "enum": [ + "id", + "include", + "name", + "registered_date" + ] + } }, { "description": "Limit result set to resources with a specific email.", "in": "query", "name": "email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to resources with a specific role.", @@ -32264,21 +51159,27 @@ "required": false, "schema": { "enum": [ - "all", "administrator", - "editor", + "all", "author", "contributor", - "subscriber", "customer", - "shop_manager" + "editor", + "shop_manager", + "subscriber" ] } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32289,15 +51190,42 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "New user email address.", "required": true, "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "New user password.", "required": true, "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "New user username.", "required": false, "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "New user email address.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "New user password.", + "required": true, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "New user username.", + "required": false, + "type": "string" + } }, - "required": ["email", "password"], + "required": [ + "email", + "password" + ], "type": "object" } } @@ -32305,7 +51233,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32318,13 +51252,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32333,7 +51288,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32344,13 +51305,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32359,7 +51341,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32370,13 +51358,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32385,7 +51394,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32406,12 +51421,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, "description": "OK" } } @@ -32437,7 +51462,10 @@ "description": "Required to be true, as resource does not support binning.", "type": "boolean" }, - "reassign": { "description": "ID to reassign posts to.", "type": "integer" } + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } }, "type": "object" } @@ -32446,7 +51474,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32465,12 +51499,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32490,13 +51535,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32505,7 +51571,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32525,13 +51597,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32540,7 +51633,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32560,13 +51659,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32575,7 +51695,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32589,21 +51715,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -32617,28 +51753,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -32652,14 +51800,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", @@ -32676,14 +51838,14 @@ "schema": { "enum": [ "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ] } }, @@ -32711,7 +51873,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32722,27 +51890,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32751,7 +51958,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32764,27 +51977,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32793,7 +52045,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32804,27 +52062,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32833,7 +52130,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32844,27 +52147,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32873,7 +52215,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32895,7 +52243,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -32904,7 +52255,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32923,12 +52280,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32948,27 +52316,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32977,7 +52384,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32997,27 +52410,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -33026,7 +52478,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -33046,27 +52504,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -33075,7 +52572,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -33084,25 +52587,48 @@ "/wc/v1/orders/{order_id}/notes": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -33113,9 +52639,15 @@ "description": "Shows/define if the note is only for reference or for the customer (the user will be notified).", "type": "boolean" }, - "note": { "description": "Order note content.", "required": true, "type": "string" } + "note": { + "description": "Order note content.", + "required": true, + "type": "string" + } }, - "required": ["note"], + "required": [ + "note" + ], "type": "object" } } @@ -33123,7 +52655,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -33139,7 +52677,13 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -33158,7 +52702,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -33172,18 +52722,35 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -33192,27 +52759,43 @@ "/wc/v1/orders/{order_id}/refunds": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -33226,28 +52809,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -33261,14 +52856,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", @@ -33285,14 +52894,14 @@ "schema": { "enum": [ "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ] } }, @@ -33320,22 +52929,40 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "amount": { "description": "Refund amount.", "type": "string" }, - "reason": { "description": "Reason for refund.", "type": "string" } + "amount": { + "description": "Refund amount.", + "type": "string" + }, + "reason": { + "description": "Reason for refund.", + "type": "string" + } }, "type": "object" } @@ -33344,7 +52971,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -33353,7 +52986,13 @@ "/wc/v1/orders/{order_id}/refunds/{id}": { "delete": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -33379,14 +53018,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -33399,12 +53050,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -33418,21 +53080,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -33446,28 +53118,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -33481,14 +53165,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", @@ -33509,14 +53207,30 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products assigned a specific category ID.", @@ -33563,7 +53277,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -33574,7 +53294,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -33583,14 +53306,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -33603,47 +53350,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -33652,7 +53474,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -33666,12 +53494,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -33682,16 +53521,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -33699,7 +53553,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -33712,14 +53572,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -33728,7 +53600,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -33739,14 +53617,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -33755,7 +53645,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -33766,14 +53662,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -33782,7 +53690,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -33803,21 +53717,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -33831,14 +53755,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -33852,14 +53784,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -33893,7 +53840,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -33914,15 +53865,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -33931,7 +53894,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -33954,9 +53921,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -33969,7 +53945,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -33989,9 +53971,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34004,7 +53995,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34024,9 +54021,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34039,7 +54045,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34081,7 +54093,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34108,13 +54124,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34142,9 +54167,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34158,7 +54192,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34186,9 +54224,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34202,7 +54249,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34230,9 +54281,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34246,7 +54306,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34281,7 +54345,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34300,12 +54370,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34325,14 +54406,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -34341,7 +54434,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34361,14 +54460,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -34377,7 +54488,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34397,14 +54514,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -34413,7 +54542,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34426,7 +54561,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -34435,14 +54573,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -34455,47 +54617,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -34504,7 +54741,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34515,7 +54758,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -34524,14 +54770,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -34544,47 +54814,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -34593,7 +54938,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34604,7 +54955,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -34613,14 +54967,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -34633,47 +55011,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -34682,7 +55135,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34696,21 +55155,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -34724,14 +55193,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -34745,14 +55222,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -34785,7 +55277,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -34796,18 +55294,39 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -34815,7 +55334,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -34828,12 +55353,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34846,7 +55389,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34857,12 +55406,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34875,7 +55442,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34886,12 +55459,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34904,7 +55495,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34938,7 +55535,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -34957,12 +55560,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -34982,12 +55596,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35000,7 +55632,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -35020,12 +55658,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35038,7 +55694,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -35058,12 +55720,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35076,7 +55756,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -35090,21 +55776,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -35118,14 +55814,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -35139,14 +55843,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -35180,7 +55899,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35192,14 +55915,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -35208,7 +55940,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35222,8 +55958,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35236,7 +55978,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35247,8 +55995,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35261,7 +56015,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35272,8 +56032,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35286,7 +56052,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35321,7 +56093,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35341,13 +56117,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35368,8 +56153,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35383,7 +56174,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35404,8 +56199,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35419,7 +56220,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35440,8 +56245,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35455,7 +56266,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35470,21 +56285,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -35498,14 +56323,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -35519,14 +56352,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -35559,7 +56407,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35570,14 +56424,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -35585,7 +56448,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35598,8 +56467,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35612,7 +56487,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35623,8 +56504,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35637,7 +56524,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35648,8 +56541,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35662,7 +56561,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35696,7 +56601,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35715,12 +56626,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35740,8 +56662,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35754,7 +56682,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35774,8 +56708,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35788,7 +56728,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35808,8 +56754,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35822,7 +56774,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35844,7 +56802,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -35853,7 +56814,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -35872,12 +56839,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -35897,7 +56875,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -35906,14 +56887,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -35926,47 +56931,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -35975,7 +57055,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -35995,7 +57081,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -36004,14 +57093,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -36024,47 +57137,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -36073,7 +57261,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -36093,7 +57287,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -36102,14 +57299,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -36122,47 +57343,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -36171,7 +57467,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -36199,12 +57501,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36226,15 +57539,40 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, - "id": { "description": "Unique identifier for the variation.", "type": "integer" }, - "name": { "description": "Name of the reviewer.", "required": true, "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "Review content.", "required": true, "type": "string" } + "email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "type": "integer" + }, + "name": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + } }, - "required": ["review", "name", "email"], + "required": [ + "email", + "name", + "review" + ], "type": "object" } } @@ -36242,7 +57580,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36271,7 +57615,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -36280,7 +57627,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36306,12 +57659,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36340,12 +57704,27 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -36354,7 +57733,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36383,12 +57768,27 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -36397,7 +57797,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36426,12 +57832,27 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -36440,7 +57861,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36454,12 +57881,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, "description": "OK" } } @@ -36473,33 +57910,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, "description": "OK" } } @@ -36513,33 +57971,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, "description": "OK" } } @@ -36553,21 +58032,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -36581,26 +58070,49 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { "description": "Sort by tax class.", "in": "query", "name": "class", "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36611,20 +58123,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36633,7 +58175,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36646,20 +58194,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36668,7 +58246,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -36679,20 +58263,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36701,7 +58315,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -36712,20 +58332,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36734,7 +58384,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -36748,12 +58404,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -36763,8 +58430,16 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "name": { "description": "Tax class name.", "required": true, "type": "string" } }, - "required": ["name"], + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], "type": "object" } } @@ -36772,7 +58447,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -36806,7 +58487,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -36840,7 +58527,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36859,12 +58552,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36884,20 +58588,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36906,7 +58640,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36926,20 +58666,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36948,7 +58718,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36968,20 +58744,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36990,7 +58796,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -37004,21 +58816,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -37032,28 +58854,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -37067,26 +58901,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "title"] } + "schema": { + "enum": [ + "date", + "id", + "title" + ] + } }, { "description": "Limit result set to webhooks assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37097,16 +58955,33 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "delivery_url": { "description": "Webhook delivery URL.", "required": true, "type": "string" }, - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "delivery_url": { + "description": "Webhook delivery URL.", + "required": true, + "type": "string" + }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "required": true, "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": true, + "type": "string" + } }, - "required": ["topic", "delivery_url"], + "required": [ + "delivery_url", + "topic" + ], "type": "object" } } @@ -37114,7 +58989,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37127,13 +59008,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37142,7 +59032,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37153,13 +59049,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37168,7 +59073,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37179,13 +59090,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37194,7 +59114,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37228,7 +59154,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37247,12 +59179,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37272,13 +59215,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37287,7 +59239,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37307,13 +59265,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37322,7 +59289,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37342,13 +59315,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37357,7 +59339,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37378,12 +59366,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, "description": "OK" } } @@ -37411,12 +59410,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, "description": "OK" } } @@ -37425,10 +59435,26 @@ "/wc/v2": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v2/coupons": { @@ -37439,21 +59465,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -37467,28 +59503,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -37502,14 +59546,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -37523,14 +59575,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to resources with a specific code.", @@ -37542,7 +59608,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -37557,16 +59629,29 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "required": true, "type": "string" }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -37603,7 +59688,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -37612,7 +59700,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -37626,7 +59717,9 @@ "type": "integer" } }, - "required": ["code"], + "required": [ + "code" + ], "type": "object" } } @@ -37634,7 +59727,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -37651,16 +59750,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -37697,7 +59808,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -37706,7 +59820,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -37727,7 +59844,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37742,16 +59865,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -37788,7 +59923,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -37797,7 +59935,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -37818,7 +59959,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37833,16 +59980,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -37879,7 +60038,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -37888,7 +60050,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -37909,7 +60074,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37931,7 +60102,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -37940,7 +60114,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -37959,12 +60139,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -37988,16 +60179,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -38034,7 +60237,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -38043,7 +60249,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -38064,7 +60273,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -38088,16 +60303,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -38134,7 +60361,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -38143,7 +60373,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -38164,7 +60397,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -38188,16 +60427,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -38234,7 +60485,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -38243,7 +60497,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -38264,7 +60521,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -38278,21 +60541,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -38306,14 +60579,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -38327,21 +60608,35 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } + "schema": { + "enum": [ + "id", + "include", + "name", + "registered_date" + ] + } }, { "description": "Limit result set to resources with a specific email.", "in": "query", "name": "email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to resources with a specific role.", @@ -38350,21 +60645,27 @@ "required": false, "schema": { "enum": [ - "all", "administrator", - "editor", + "all", "author", "contributor", - "subscriber", "customer", - "shop_manager" + "editor", + "shop_manager", + "subscriber" ] } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38375,16 +60676,46 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "New user email address.", "required": true, "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "New user password.", "required": true, "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "New user username.", "required": false, "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "New user email address.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "New user password.", + "required": true, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "New user username.", + "required": false, + "type": "string" + } }, - "required": ["email", "password"], + "required": [ + "email", + "password" + ], "type": "object" } } @@ -38392,7 +60723,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38405,14 +60742,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38421,7 +60782,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38432,14 +60799,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38448,7 +60839,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38459,14 +60856,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38475,7 +60896,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38496,12 +60923,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, "description": "OK" } } @@ -38527,7 +60964,10 @@ "description": "Required to be true, as resource does not support binning.", "type": "boolean" }, - "reassign": { "description": "ID to reassign posts to.", "type": "integer" } + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } }, "type": "object" } @@ -38536,7 +60976,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38555,12 +61001,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38580,14 +61037,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38596,7 +61077,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38616,14 +61103,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38632,7 +61143,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38652,14 +61169,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38668,7 +61209,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38682,21 +61229,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -38710,28 +61267,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -38745,14 +61310,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -38766,28 +61339,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to orders assigned a specific status.", @@ -38797,16 +61392,16 @@ "schema": { "enum": [ "any", - "trash", "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ] } }, @@ -38843,19 +61438,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -38866,28 +61475,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -38896,7 +61547,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -38909,28 +61566,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -38939,7 +61638,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38950,28 +61655,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -38980,7 +61727,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38991,28 +61744,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -39021,7 +61816,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -39043,7 +61844,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -39052,7 +61856,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39071,12 +61881,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39096,28 +61917,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -39126,7 +61989,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39146,28 +62015,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -39176,7 +62087,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39196,28 +62113,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -39226,7 +62185,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39235,32 +62200,61 @@ "/wc/v2/orders/{order_id}/notes": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit result to customers or internal notes.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["any", "customer", "internal"] } + "schema": { + "enum": [ + "any", + "customer", + "internal" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -39271,9 +62265,15 @@ "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "type": "boolean" }, - "note": { "description": "Order note content.", "required": true, "type": "string" } + "note": { + "description": "Order note content.", + "required": true, + "type": "string" + } }, - "required": ["note"], + "required": [ + "note" + ], "type": "object" } } @@ -39281,7 +62281,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -39297,7 +62303,13 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -39316,7 +62328,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -39330,18 +62348,35 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -39350,27 +62385,43 @@ "/wc/v2/orders/{order_id}/refunds": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -39384,28 +62435,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -39419,14 +62478,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -39440,28 +62507,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Number of decimal points to use in each resource.", @@ -39482,42 +62571,80 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "amount": { "description": "Refund amount.", "type": "string" }, + "amount": { + "description": "Refund amount.", + "type": "string" + }, "api_refund": { "description": "When true, the payment gateway API is used to generate the refund.", "type": "boolean" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "reason": { "description": "Reason for refund.", "type": "string" }, - "refunded_by": { "description": "User ID of user who created the refund.", "type": "integer" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" } + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "reason": { + "description": "Reason for refund.", + "type": "string" + }, + "refunded_by": { + "description": "User ID of user who created the refund.", + "type": "integer" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + } }, "type": "object" } @@ -39526,7 +62653,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -39535,7 +62668,13 @@ "/wc/v2/orders/{order_id}/refunds/{id}": { "delete": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -39561,14 +62700,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -39581,12 +62732,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -39600,12 +62762,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39626,12 +62799,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39651,11 +62835,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -39664,7 +62863,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39684,11 +62889,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -39697,7 +62917,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39717,11 +62943,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -39730,7 +62971,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39744,21 +62991,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -39772,28 +63029,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -39807,14 +63072,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -39828,7 +63101,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -39840,14 +63118,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ] } }, @@ -39856,14 +63134,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -39877,14 +63163,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -39968,19 +63271,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -39991,7 +63308,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -40000,28 +63320,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -40030,48 +63380,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -40080,7 +63508,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -40094,12 +63528,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40110,16 +63555,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -40127,7 +63587,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40140,14 +63606,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40156,7 +63634,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40167,14 +63651,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40183,7 +63679,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40194,14 +63696,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40210,7 +63724,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40231,21 +63751,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -40259,14 +63789,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -40280,14 +63818,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -40321,7 +63874,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40342,15 +63899,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -40359,7 +63928,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40382,9 +63955,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40397,7 +63979,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40417,9 +64005,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40432,7 +64029,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40452,9 +64055,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40467,7 +64079,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40509,7 +64127,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40536,13 +64158,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40570,9 +64201,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40586,7 +64226,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40614,9 +64258,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40630,7 +64283,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40658,9 +64315,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40674,7 +64340,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40709,7 +64379,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40728,12 +64404,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40753,14 +64440,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40769,7 +64468,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40789,14 +64494,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40805,7 +64522,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40825,14 +64548,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40841,7 +64576,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40854,7 +64595,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -40863,28 +64607,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -40893,48 +64667,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -40943,7 +64795,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40954,7 +64812,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -40963,28 +64824,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -40993,48 +64884,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -41043,7 +65012,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41054,7 +65029,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -41063,28 +65041,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -41093,48 +65101,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -41143,7 +65229,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41157,21 +65249,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -41185,14 +65287,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -41206,14 +65316,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -41246,7 +65371,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41257,18 +65388,39 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -41276,7 +65428,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41289,12 +65447,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41307,7 +65483,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41318,12 +65500,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41336,7 +65536,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41347,12 +65553,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41365,7 +65589,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41399,7 +65629,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41418,12 +65654,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41443,12 +65690,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41461,7 +65726,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41481,12 +65752,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41499,7 +65788,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41519,12 +65814,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41537,7 +65850,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41551,21 +65870,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -41579,14 +65908,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -41600,14 +65937,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -41641,7 +65993,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41653,14 +66009,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -41669,7 +66034,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41683,8 +66052,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41697,7 +66072,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41708,8 +66089,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41722,7 +66109,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41733,8 +66126,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41747,7 +66146,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41782,7 +66187,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41802,13 +66211,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41829,8 +66247,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41844,7 +66268,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41865,8 +66293,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41880,7 +66314,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41901,8 +66339,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41916,7 +66360,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41931,21 +66379,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -41959,14 +66417,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -41980,14 +66446,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -42020,7 +66501,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42031,14 +66518,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -42046,7 +66542,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42059,8 +66561,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42073,7 +66581,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42084,8 +66598,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42098,7 +66618,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42109,8 +66635,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42123,7 +66655,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42157,7 +66695,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42176,12 +66720,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42201,8 +66756,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42215,7 +66776,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42235,8 +66802,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42249,7 +66822,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42269,8 +66848,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42283,7 +66868,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42305,7 +66896,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -42314,7 +66908,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42333,12 +66933,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42358,7 +66969,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -42367,28 +66981,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -42397,48 +67041,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -42447,7 +67169,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42467,7 +67195,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -42476,28 +67207,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -42506,48 +67267,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -42556,7 +67395,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42576,7 +67421,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -42585,28 +67433,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -42615,48 +67493,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -42665,7 +67621,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42693,12 +67655,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -42720,19 +67693,47 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, - "id": { "description": "Unique identifier for the variation.", "type": "integer" }, - "name": { "description": "Name of the reviewer.", "required": true, "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "Review content.", "required": true, "type": "string" } + "email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "type": "integer" + }, + "name": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + } }, - "required": ["review", "name", "email"], + "required": [ + "email", + "name", + "review" + ], "type": "object" } } @@ -42740,7 +67741,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -42764,16 +67771,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -42782,7 +67807,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42804,16 +67835,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -42822,7 +67871,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42844,16 +67899,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -42862,7 +67935,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42891,7 +67970,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -42900,7 +67982,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -42926,12 +68014,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -42960,16 +68059,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -42978,7 +68095,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -43007,16 +68130,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -43025,7 +68166,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -43054,16 +68201,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -43072,7 +68237,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -43093,21 +68264,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -43121,28 +68302,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -43156,14 +68345,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -43177,28 +68374,51 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -43212,14 +68432,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -43303,19 +68540,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43335,29 +68586,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43366,32 +68638,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43400,7 +68722,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43422,29 +68750,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43453,32 +68802,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43487,7 +68886,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -43507,29 +68912,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43538,32 +68964,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43572,7 +69048,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -43592,29 +69074,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43623,32 +69126,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43657,7 +69210,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -43686,7 +69245,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -43695,7 +69257,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43721,12 +69289,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43753,29 +69332,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43784,32 +69384,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43818,7 +69468,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43845,29 +69501,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43876,32 +69553,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43910,7 +69637,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43937,29 +69670,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43968,32 +69722,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -44002,7 +69806,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -44016,12 +69826,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, "description": "OK" } } @@ -44035,33 +69855,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, "description": "OK" } } @@ -44075,33 +69916,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, "description": "OK" } } @@ -44111,7 +69973,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting_group" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting_group" + } + } + }, "description": "OK" } } @@ -44120,12 +69988,30 @@ "/wc/v2/settings/{group_id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44133,16 +70019,35 @@ }, "/wc/v2/settings/{group_id}/batch": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44152,22 +70057,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44177,22 +70107,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44202,7 +70157,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -44211,7 +70172,13 @@ "/wc/v2/settings/{group_id}/{id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -44219,11 +70186,23 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44237,17 +70216,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44257,7 +70253,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44271,17 +70273,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44291,7 +70310,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44305,17 +70330,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44325,7 +70367,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44335,7 +70383,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -44346,10 +70400,19 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "required": true, "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -44357,7 +70420,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -44366,14 +70435,23 @@ "/wc/v2/shipping/zones/{id}": { "delete": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -44382,33 +70460,63 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -44417,22 +70525,40 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -44441,22 +70567,40 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -44465,7 +70609,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -44474,12 +70624,22 @@ "/wc/v2/shipping/zones/{id}/locations": { "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -44487,15 +70647,27 @@ }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -44505,7 +70677,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -44513,15 +70689,27 @@ }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -44531,7 +70719,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -44539,15 +70731,27 @@ }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -44557,7 +70761,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -44567,30 +70775,62 @@ "/wc/v2/shipping/zones/{zone_id}/methods": { "get": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} } + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} } + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "method_id": { "description": "Shipping method ID.", "required": true }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "method_id": { + "description": "Shipping method ID.", + "required": true + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, - "required": ["method_id"], + "required": [ + "method_id" + ], "type": "object" } } @@ -44598,7 +70838,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } @@ -44607,7 +70853,13 @@ "/wc/v2/shipping/zones/{zone_id}/methods/{instance_id}": { "delete": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44621,7 +70873,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -44630,14 +70885,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44648,14 +70915,26 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44669,9 +70948,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -44680,14 +70968,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44701,9 +71001,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -44712,14 +71021,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44733,9 +71054,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -44744,7 +71074,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } @@ -44758,12 +71094,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, "description": "OK" } } @@ -44784,12 +71130,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, "description": "OK" } } @@ -44803,12 +71159,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status" + } + } + }, "description": "OK" } } @@ -44822,12 +71188,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44846,7 +71223,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44866,11 +71249,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -44879,7 +71277,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44899,11 +71303,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -44912,7 +71331,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44932,11 +71357,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -44945,7 +71385,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44959,21 +71405,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -44987,26 +71443,49 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { "description": "Sort by tax class.", "in": "query", "name": "class", "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45017,20 +71496,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45039,7 +71548,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45052,20 +71567,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45074,7 +71619,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45085,20 +71636,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45107,7 +71688,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45118,20 +71705,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45140,7 +71757,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45154,12 +71777,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -45169,8 +71803,16 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "name": { "description": "Tax class name.", "required": true, "type": "string" } }, - "required": ["name"], + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], "type": "object" } } @@ -45178,7 +71820,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -45212,7 +71860,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -45229,7 +71883,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -45263,7 +71923,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45282,12 +71948,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45307,20 +71984,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45329,7 +72036,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45349,20 +72062,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45371,7 +72114,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45391,20 +72140,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45413,7 +72192,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45427,21 +72212,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -45455,28 +72250,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -45490,26 +72297,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "title"] } + "schema": { + "enum": [ + "date", + "id", + "title" + ] + } }, { "description": "Limit result set to webhooks assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45520,16 +72351,33 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "delivery_url": { "description": "Webhook delivery URL.", "required": true, "type": "string" }, - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "delivery_url": { + "description": "Webhook delivery URL.", + "required": true, + "type": "string" + }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "required": true, "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": true, + "type": "string" + } }, - "required": ["topic", "delivery_url"], + "required": [ + "delivery_url", + "topic" + ], "type": "object" } } @@ -45537,7 +72385,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45550,13 +72404,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45565,7 +72428,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45576,13 +72445,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45591,7 +72469,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45602,13 +72486,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45617,7 +72510,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45651,7 +72550,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45670,12 +72575,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45695,13 +72611,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45710,7 +72635,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45730,13 +72661,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45745,7 +72685,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45765,13 +72711,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45780,7 +72735,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45801,12 +72762,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, "description": "OK" } } @@ -45834,12 +72806,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, "description": "OK" } } @@ -45848,10 +72831,26 @@ "/wc/v3": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/coupons": { @@ -45862,21 +72861,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -45890,28 +72899,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -45925,14 +72942,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -45946,14 +72971,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to resources with a specific code.", @@ -45965,7 +73004,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -45980,16 +73025,29 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "required": true, "type": "string" }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46026,7 +73084,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46035,7 +73096,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46049,7 +73113,9 @@ "type": "integer" } }, - "required": ["code"], + "required": [ + "code" + ], "type": "object" } } @@ -46057,7 +73123,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46074,16 +73146,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46120,7 +73204,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46129,7 +73216,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46150,7 +73240,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46165,16 +73261,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46211,7 +73319,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46220,7 +73331,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46241,7 +73355,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46256,16 +73376,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46302,7 +73434,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46311,7 +73446,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46332,7 +73470,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46354,7 +73498,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -46363,7 +73510,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46382,12 +73535,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46411,16 +73575,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46457,7 +73633,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46466,7 +73645,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46487,7 +73669,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46511,16 +73699,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46557,7 +73757,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46566,7 +73769,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46587,7 +73793,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46611,16 +73823,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46657,7 +73881,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46666,7 +73893,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46687,7 +73917,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46701,21 +73937,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -46729,14 +73975,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -46750,21 +74004,35 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } + "schema": { + "enum": [ + "id", + "include", + "name", + "registered_date" + ] + } }, { "description": "Limit result set to resources with a specific email.", "in": "query", "name": "email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to resources with a specific role.", @@ -46773,21 +74041,27 @@ "required": false, "schema": { "enum": [ - "all", "administrator", - "editor", + "all", "author", "contributor", - "subscriber", "customer", - "shop_manager" + "editor", + "shop_manager", + "subscriber" ] } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -46798,16 +74072,46 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "New user email address.", "required": true, "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "New user password.", "required": true, "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "New user username.", "required": false, "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "New user email address.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "New user password.", + "required": true, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "New user username.", + "required": false, + "type": "string" + } }, - "required": ["email", "password"], + "required": [ + "email", + "password" + ], "type": "object" } } @@ -46815,7 +74119,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -46828,14 +74138,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -46844,7 +74178,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46855,14 +74195,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -46871,7 +74235,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46882,14 +74252,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -46898,7 +74292,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46919,12 +74319,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, "description": "OK" } } @@ -46950,7 +74360,10 @@ "description": "Required to be true, as resource does not support binning.", "type": "boolean" }, - "reassign": { "description": "ID to reassign posts to.", "type": "integer" } + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } }, "type": "object" } @@ -46959,7 +74372,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -46978,12 +74397,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -47003,14 +74433,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -47019,7 +74473,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -47039,14 +74499,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -47055,7 +74539,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -47075,14 +74565,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -47091,7 +74605,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -47101,7 +74621,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -47111,7 +74637,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_continents" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_continents" + } + } + }, "description": "OK" } } @@ -47127,11 +74659,23 @@ "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "location", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "location", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_continents" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_continents" + } + } + }, "description": "OK" } } @@ -47141,7 +74685,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -47160,7 +74710,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -47170,7 +74726,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, "description": "OK" } } @@ -47180,7 +74742,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, "description": "OK" } } @@ -47196,11 +74764,23 @@ "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "currency", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "currency", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, "description": "OK" } } @@ -47217,7 +74797,11 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/layout-templates/{id}": { @@ -47231,7 +74815,11 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/marketplace/create-order": { @@ -47240,33 +74828,78 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "product_id": { "required": true } }, - "required": ["product_id"], + "properties": { + "product_id": { + "required": true + } + }, + "required": [ + "product_id" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/featured": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/refresh": { + "post": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/subscriptions": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/wc/v3/marketplace/featured": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wc/v3/marketplace/refresh": { "post": { "responses": { "200": { "description": "OK" } } } }, - "/wc/v3/marketplace/subscriptions": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wc/v3/marketplace/subscriptions/activate": { "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "product_key": { "required": true, "type": "string" } }, - "required": ["product_key"], + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/marketplace/subscriptions/connect": { @@ -47275,14 +74908,25 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "product_key": { "required": true, "type": "string" } }, - "required": ["product_key"], + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/marketplace/subscriptions/disconnect": { @@ -47291,20 +74935,43 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "product_key": { "required": true, "type": "string" } }, - "required": ["product_key"], + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/marketplace/subscriptions/install-url": { "get": { - "parameters": [{ "description": "", "in": "query", "name": "product_key", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "query", + "name": "product_key", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/orders": { @@ -47315,21 +74982,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -47343,28 +75020,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -47378,14 +75063,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -47399,28 +75092,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to orders which have specific statuses.", @@ -47431,16 +75146,16 @@ "items": { "enum": [ "any", - "trash", "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -47479,19 +75194,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47502,32 +75231,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47536,7 +75307,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47549,32 +75326,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47583,7 +75402,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -47594,32 +75419,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47628,7 +75495,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -47639,32 +75512,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47673,7 +75588,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -47695,7 +75616,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -47704,7 +75628,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47723,12 +75653,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47748,32 +75689,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47782,7 +75765,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47802,32 +75791,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47836,7 +75867,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47856,32 +75893,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47890,7 +75969,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47907,7 +75992,11 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "parameters": [ @@ -47924,7 +76013,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "expiration_date": { "description": "Expiration date formatted as dd-mm-yyyy.", "type": "string" }, + "expiration_date": { + "description": "Expiration date formatted as dd-mm-yyyy.", + "type": "string" + }, "expiration_days": { "description": "Number of days to be added to the current date to get the expiration date.", "type": "integer" @@ -47940,38 +76032,71 @@ } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/orders/{order_id}/notes": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit result to customers or internal notes.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["any", "customer", "internal"] } + "schema": { + "enum": [ + "any", + "customer", + "internal" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -47986,9 +76111,15 @@ "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "type": "boolean" }, - "note": { "description": "Order note content.", "required": true, "type": "string" } + "note": { + "description": "Order note content.", + "required": true, + "type": "string" + } }, - "required": ["note"], + "required": [ + "note" + ], "type": "object" } } @@ -47996,7 +76127,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -48012,7 +76149,13 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -48031,7 +76174,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -48045,18 +76194,35 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -48065,27 +76231,43 @@ "/wc/v3/orders/{order_id}/refunds": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -48099,28 +76281,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -48134,14 +76324,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -48155,28 +76353,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Number of decimal points to use in each resource.", @@ -48197,43 +76417,84 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "amount": { "description": "Refund amount.", "type": "string" }, + "amount": { + "description": "Refund amount.", + "type": "string" + }, "api_refund": { "description": "When true, the payment gateway API is used to generate the refund.", "type": "boolean" }, - "api_restock": { "description": "When true, refunded items are restocked.", "type": "boolean" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "reason": { "description": "Reason for refund.", "type": "string" }, - "refunded_by": { "description": "User ID of user who created the refund.", "type": "integer" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" } + "api_restock": { + "description": "When true, refunded items are restocked.", + "type": "boolean" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "reason": { + "description": "Reason for refund.", + "type": "string" + }, + "refunded_by": { + "description": "User ID of user who created the refund.", + "type": "integer" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + } }, "type": "object" } @@ -48242,7 +76503,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -48251,7 +76518,13 @@ "/wc/v3/orders/{order_id}/refunds/{id}": { "delete": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -48277,14 +76550,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -48297,12 +76582,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -48316,12 +76612,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48342,12 +76649,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48367,11 +76685,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -48380,7 +76713,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48400,11 +76739,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -48413,7 +76767,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48433,11 +76793,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -48446,7 +76821,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48460,21 +76841,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -48488,28 +76879,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -48523,14 +76922,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -48544,7 +76951,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -48556,17 +76968,17 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", - "rating", - "menu_order", + "popularity", "price", - "popularity", - "rating" + "rating", + "rating", + "rating", + "slug", + "title" ] } }, @@ -48575,14 +76987,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -48596,14 +77016,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -48680,21 +77117,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit results to those with a SKU that partially matches a string.", @@ -48706,7 +77157,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -48717,7 +77174,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -48726,36 +77186,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -48764,50 +77260,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -48816,7 +77399,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -48830,12 +77419,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -48846,16 +77446,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -48863,7 +77478,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -48876,14 +77497,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -48892,7 +77525,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -48903,14 +77542,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -48919,7 +77570,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -48930,14 +77587,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -48946,7 +77615,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -48967,21 +77642,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -48995,14 +77680,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -49016,14 +77709,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -49057,7 +77765,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49078,15 +77790,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -49095,7 +77819,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49118,9 +77846,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49133,7 +77870,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49153,9 +77896,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49168,7 +77920,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49188,9 +77946,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49203,7 +77970,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49245,7 +78018,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49272,13 +78049,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49306,9 +78092,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49322,7 +78117,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49350,9 +78149,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49366,7 +78174,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49394,9 +78206,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49410,7 +78231,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49445,7 +78270,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49464,12 +78295,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49489,14 +78331,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -49505,7 +78359,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49525,14 +78385,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -49541,7 +78413,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49561,14 +78439,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -49577,7 +78467,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49590,7 +78486,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -49599,36 +78498,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -49637,50 +78572,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -49689,7 +78711,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49700,7 +78728,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -49709,36 +78740,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -49747,50 +78814,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -49799,7 +78953,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49810,7 +78970,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -49819,36 +78982,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -49857,50 +79056,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -49909,7 +79195,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49923,21 +79215,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -49951,14 +79253,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -49972,14 +79282,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -50012,7 +79337,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50023,18 +79354,39 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -50042,7 +79394,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50055,12 +79413,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50073,7 +79449,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50084,12 +79466,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50102,7 +79502,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50113,12 +79519,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50131,7 +79555,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50165,7 +79595,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50184,12 +79620,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50209,12 +79656,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50227,7 +79692,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50247,12 +79718,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50265,7 +79754,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50285,12 +79780,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50303,7 +79816,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50324,14 +79843,19 @@ "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -50345,10 +79869,19 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/products/reviews": { @@ -50359,21 +79892,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -50387,28 +79930,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to reviews published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -50422,54 +79977,95 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "product"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ] + } }, { "description": "Limit result set to reviews assigned to specific user IDs.", "in": "query", "name": "reviewer", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes reviews assigned to specific user IDs.", "in": "query", "name": "reviewer_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to that from a specific author email.", "in": "query", "name": "reviewer_email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to reviews assigned to specific product IDs.", "in": "query", "name": "product", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to reviews assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "hold", "approved", "spam", "trash"] } + "schema": { + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50485,14 +80081,40 @@ "required": true, "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "Review content.", "required": true, "type": "string" }, - "reviewer": { "description": "Name of the reviewer.", "required": true, "type": "string" }, - "reviewer_email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + }, + "reviewer": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "reviewer_email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, - "required": ["product_id", "reviewer", "reviewer_email", "review"], + "required": [ + "product_id", + "review", + "reviewer", + "reviewer_email" + ], "type": "object" } } @@ -50500,7 +80122,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50517,12 +80145,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50531,7 +80177,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50546,12 +80198,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50560,7 +80230,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50575,12 +80251,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50589,7 +80283,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50611,7 +80311,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -50620,7 +80323,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50639,12 +80348,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50668,12 +80388,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50682,7 +80420,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50706,12 +80450,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50720,7 +80482,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50744,12 +80512,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50758,7 +80544,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50772,21 +80564,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -50800,14 +80602,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -50821,14 +80631,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -50862,7 +80687,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -50874,14 +80703,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -50890,7 +80728,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -50904,8 +80746,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50918,7 +80766,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50929,8 +80783,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50943,7 +80803,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50954,8 +80820,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50968,7 +80840,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50977,7 +80855,13 @@ "/wc/v3/products/shipping_classes/slug-suggestion": { "get": { "parameters": [ - { "description": "Shipping class name.", "in": "query", "name": "name", "required": false, "schema": {} }, + { + "description": "Shipping class name.", + "in": "query", + "name": "name", + "required": false, + "schema": {} + }, { "description": "An alphanumeric identifier for the resource unique to its type.", "in": "query", @@ -50996,7 +80880,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51032,7 +80920,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51052,13 +80944,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51079,8 +80980,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51094,7 +81001,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51115,8 +81026,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51130,7 +81047,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51151,8 +81072,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51166,7 +81093,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51181,21 +81112,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -51209,28 +81150,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -51244,14 +81193,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -51265,7 +81222,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -51277,14 +81239,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ] } }, @@ -51293,14 +81255,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -51314,14 +81284,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -51405,28 +81392,44 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to specific product categorie ids.", "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific product tag ids.", "in": "query", "name": "tags", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific amount of suggested products.", @@ -51438,7 +81441,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -51452,21 +81461,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -51480,14 +81499,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -51501,14 +81528,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -51541,7 +81583,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51552,14 +81600,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -51567,7 +81624,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51580,8 +81643,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51594,7 +81663,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -51605,8 +81680,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51619,7 +81700,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -51630,8 +81717,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51644,7 +81737,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -51678,7 +81777,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51697,12 +81802,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51722,8 +81838,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51736,7 +81858,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51756,8 +81884,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51770,7 +81904,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51790,8 +81930,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51804,7 +81950,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51826,7 +81978,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -51835,7 +81990,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -51854,12 +82015,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -51879,7 +82051,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -51888,36 +82063,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -51926,50 +82137,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -51978,7 +82276,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -51998,7 +82302,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -52007,36 +82314,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52045,50 +82388,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52097,7 +82527,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -52117,7 +82553,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -52126,36 +82565,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52164,50 +82639,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52216,7 +82778,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -52238,7 +82806,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -52247,36 +82818,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52285,50 +82892,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52337,7 +83031,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -52358,21 +83058,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -52386,28 +83096,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -52421,14 +83139,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -52442,28 +83168,51 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -52477,7 +83226,17 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -52512,21 +83271,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit result set to products with or without price.", @@ -52543,9 +83316,18 @@ "schema": { "items": { "properties": { - "attribute": { "description": "Attribute slug.", "type": "string" }, - "term": { "description": "Attribute term.", "type": "string" }, - "terms": { "description": "Attribute terms.", "type": "array" } + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } }, "type": "object" } @@ -52554,7 +83336,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -52574,29 +83362,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52605,28 +83414,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52635,7 +83501,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -52657,29 +83529,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52688,28 +83581,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52718,7 +83668,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -52738,29 +83694,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52769,28 +83746,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52799,7 +83833,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -52819,29 +83859,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52850,28 +83911,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52880,7 +83998,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -52902,31 +84026,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_values": { + "description": "Default values for generated variations.", + "type": "object" + }, + "delete": { + "description": "Deletes unused variations.", + "type": "boolean" + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "default_values": { "description": "Default values for generated variations.", "type": "object" }, - "delete": { "description": "Deletes unused variations.", "type": "boolean" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52935,28 +84086,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52965,7 +84173,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -52994,7 +84208,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -53003,7 +84220,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53029,12 +84252,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53061,29 +84295,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -53092,28 +84347,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -53122,7 +84434,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53149,29 +84467,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -53180,28 +84519,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -53210,7 +84606,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53237,29 +84639,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -53268,28 +84691,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -53298,7 +84778,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53312,21 +84798,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -53340,28 +84836,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -53375,14 +84879,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -53396,28 +84908,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Number of decimal points to use in each resource.", @@ -53438,19 +84972,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -53464,12 +85012,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, "description": "OK" } } @@ -53483,12 +85041,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupon_total" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupon_total" + } + } + }, "description": "OK" } } @@ -53502,13 +85070,21 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customer_total" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customer_total" + } + } }, "description": "OK" } @@ -53523,12 +85099,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_order_total" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_order_total" + } + } + }, "description": "OK" } } @@ -53542,12 +85128,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_product_total" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_product_total" + } + } + }, "description": "OK" } } @@ -53561,12 +85157,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_review_total" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_review_total" + } + } + }, "description": "OK" } } @@ -53580,33 +85186,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, "description": "OK" } } @@ -53620,33 +85247,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, "description": "OK" } } @@ -53656,7 +85304,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting_group" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting_group" + } + } + }, "description": "OK" } } @@ -53666,7 +85320,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -53674,7 +85334,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -53682,7 +85348,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -53691,12 +85363,30 @@ "/wc/v3/settings/{group_id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53704,16 +85394,35 @@ }, "/wc/v3/settings/{group_id}/batch": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53723,22 +85432,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53748,22 +85482,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53773,7 +85532,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -53782,7 +85547,13 @@ "/wc/v3/settings/{group_id}/{id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -53790,11 +85561,23 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53808,17 +85591,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53828,7 +85628,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53842,17 +85648,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53862,7 +85685,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53876,17 +85705,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53896,7 +85742,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53906,7 +85758,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -53917,10 +85775,19 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "required": true, "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -53928,7 +85795,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -53937,14 +85810,23 @@ "/wc/v3/shipping/zones/{id}": { "delete": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -53953,33 +85835,63 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -53988,22 +85900,40 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -54012,22 +85942,40 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -54036,7 +85984,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -54045,12 +85999,22 @@ "/wc/v3/shipping/zones/{id}/locations": { "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -54058,15 +86022,27 @@ }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -54076,7 +86052,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -54084,15 +86064,27 @@ }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -54102,7 +86094,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -54110,15 +86106,27 @@ }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -54128,7 +86136,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -54138,30 +86150,62 @@ "/wc/v3/shipping/zones/{zone_id}/methods": { "get": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} } + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} } + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "method_id": { "description": "Shipping method ID.", "required": true }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "method_id": { + "description": "Shipping method ID.", + "required": true + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, - "required": ["method_id"], + "required": [ + "method_id" + ], "type": "object" } } @@ -54169,7 +86213,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } @@ -54178,7 +86228,13 @@ "/wc/v3/shipping/zones/{zone_id}/methods/{instance_id}": { "delete": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54192,7 +86248,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -54201,14 +86260,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54219,14 +86290,26 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54240,9 +86323,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -54251,14 +86343,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54272,9 +86376,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -54283,14 +86396,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54304,9 +86429,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -54315,7 +86449,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } @@ -54329,12 +86469,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, "description": "OK" } } @@ -54355,12 +86505,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, "description": "OK" } } @@ -54374,12 +86534,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status" + } + } + }, "description": "OK" } } @@ -54393,12 +86563,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54417,7 +86598,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54437,11 +86624,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -54450,7 +86652,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54470,11 +86678,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -54483,7 +86706,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54503,11 +86732,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -54516,7 +86760,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54530,21 +86780,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -54558,26 +86818,49 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { "description": "Sort by tax class.", "in": "query", "name": "class", "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54588,16 +86871,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54606,13 +86907,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54621,7 +86931,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54634,16 +86950,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54652,13 +86986,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54667,7 +87010,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -54678,16 +87027,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54696,13 +87063,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54711,7 +87087,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -54722,16 +87104,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54740,13 +87140,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54755,7 +87164,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -54769,12 +87184,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -54784,8 +87210,16 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "name": { "description": "Tax class name.", "required": true, "type": "string" } }, - "required": ["name"], + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], "type": "object" } } @@ -54793,7 +87227,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -54827,7 +87267,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -54844,7 +87290,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -54878,7 +87330,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54897,12 +87355,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54922,16 +87391,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54940,13 +87427,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54955,7 +87451,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54975,16 +87477,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54993,13 +87513,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -55008,7 +87537,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -55028,16 +87563,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -55046,13 +87599,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -55061,7 +87623,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -55075,21 +87643,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -55103,28 +87681,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -55138,26 +87728,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "title"] } + "schema": { + "enum": [ + "date", + "id", + "title" + ] + } }, { "description": "Limit result set to webhooks assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55168,16 +87782,33 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "delivery_url": { "description": "Webhook delivery URL.", "required": true, "type": "string" }, - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "delivery_url": { + "description": "Webhook delivery URL.", + "required": true, + "type": "string" + }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "required": true, "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": true, + "type": "string" + } }, - "required": ["topic", "delivery_url"], + "required": [ + "delivery_url", + "topic" + ], "type": "object" } } @@ -55185,7 +87816,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55198,13 +87835,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55213,7 +87859,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -55224,13 +87876,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55239,7 +87900,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -55250,13 +87917,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55265,7 +87941,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -55299,7 +87981,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55318,12 +88006,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55343,13 +88042,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55358,7 +88066,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55378,13 +88092,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55393,7 +88116,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55413,13 +88142,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55428,7 +88166,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55437,10 +88181,26 @@ "/wccom-site/v3": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wccom-site/v3/installer": { @@ -55450,17 +88210,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" }, - "run-until-step": { "required": true, "type": "string" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + }, + "run-until-step": { + "required": true, + "type": "string" + } }, - "required": ["product-id", "run-until-step", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id", + "run-until-step" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -55468,17 +88245,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" }, - "run-until-step": { "required": true, "type": "string" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + }, + "run-until-step": { + "required": true, + "type": "string" + } }, - "required": ["product-id", "run-until-step", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id", + "run-until-step" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -55486,17 +88280,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" }, - "run-until-step": { "required": true, "type": "string" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + }, + "run-until-step": { + "required": true, + "type": "string" + } }, - "required": ["product-id", "run-until-step", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id", + "run-until-step" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wccom-site/v3/installer/reset": { @@ -55506,16 +88317,29 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + } }, - "required": ["product-id", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -55523,16 +88347,29 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + } }, - "required": ["product-id", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -55540,35 +88377,94 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + } }, - "required": ["product-id", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wccom-site/v3/ssr": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wccom-site/v3/status": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/wccom-site/v3/ssr": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wccom-site/v3/status": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wp-block-editor/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp-block-editor/v1/export": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/wp-block-editor/v1/export": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wp-block-editor/v1/navigation-fallback": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/navigation-fallback" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/navigation-fallback" + } + } + }, "description": "OK" } } @@ -55582,42 +88478,106 @@ "in": "query", "name": "url", "required": true, - "schema": { "format": "uri" } + "schema": { + "format": "uri" + } } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp-openapi/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp-openapi/v1/schema": { "get": { - "parameters": [{ "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp-site-health/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/directory-sizes": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/wp-site-health/v1/directory-sizes": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wp-site-health/v1/tests/authorization-header": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, "description": "OK" } } @@ -55627,7 +88587,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, "description": "OK" } } @@ -55637,7 +88603,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, "description": "OK" } } @@ -55647,7 +88619,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, "description": "OK" } } @@ -55657,20 +88635,50 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/tests/page-cache": { + "get": { + "responses": { + "200": { "description": "OK" } } } }, - "/wp-site-health/v1/tests/page-cache": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wp/v2": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/block-directory/search": { @@ -55681,33 +88689,50 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit result set to blocks matching the search term.", "in": "query", "name": "term", "required": true, - "schema": { "minLength": 1 } + "schema": { + "minLength": 1 + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-directory-item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-directory-item" + } + } + }, "description": "OK" } } @@ -55718,7 +88743,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/block-pattern-category" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-pattern-category" + } + } }, "description": "OK" } @@ -55729,7 +88758,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-pattern" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-pattern" + } + } + }, "description": "OK" } } @@ -55750,7 +88785,11 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["edit"] } + "schema": { + "enum": [ + "edit" + ] + } }, { "description": "Attributes for the block.", @@ -55769,7 +88808,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rendered-block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rendered-block" + } + } + }, "description": "OK" } } @@ -55789,12 +88834,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "Attributes for the block.", "type": "object" }, + "attributes": { + "description": "Attributes for the block.", + "type": "object" + }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "post_id": { "description": "ID of the post context.", "type": "integer" } + "post_id": { + "description": "ID of the post context.", + "type": "integer" + } }, "type": "object" } @@ -55803,7 +88854,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rendered-block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rendered-block" + } + } + }, "description": "OK" } } @@ -55817,13 +88874,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "Block namespace.", "in": "query", "name": "namespace", "required": false, "schema": {} } + { + "description": "Block namespace.", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, "description": "OK" } } @@ -55837,13 +88912,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "Block namespace.", "in": "path", "name": "namespace", "required": true, "schema": {} } + { + "description": "Block namespace.", + "in": "path", + "name": "namespace", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, "description": "OK" } } @@ -55852,19 +88945,43 @@ "/wp/v2/block-types/{namespace}/{name}": { "get": { "parameters": [ - { "description": "Block name.", "in": "path", "name": "name", "required": true, "schema": {} }, - { "description": "Block namespace.", "in": "path", "name": "namespace", "required": true, "schema": {} }, + { + "description": "Block name.", + "in": "path", + "name": "name", + "required": true, + "schema": {} + }, + { + "description": "Block namespace.", + "in": "path", + "name": "namespace", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, "description": "OK" } } @@ -55878,21 +88995,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -55906,42 +89034,58 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -55955,7 +89099,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -55968,11 +89117,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ] } @@ -55982,14 +89131,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -55999,27 +89161,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -56030,7 +89192,12 @@ "in": "query", "name": "tax_relation", "required": false, - "schema": { "enum": ["AND", "OR"] } + "schema": { + "enum": [ + "AND", + "OR" + ] + } }, { "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", @@ -56041,7 +89208,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -56052,13 +89221,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -56077,7 +89251,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -56088,7 +89264,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -56101,7 +89279,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56112,14 +89296,32 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56128,9 +89330,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56143,7 +89354,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56165,7 +89382,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -56174,7 +89394,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56193,7 +89419,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Override the default excerpt length.", @@ -56212,7 +89444,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56232,14 +89470,32 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56248,9 +89504,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56263,7 +89528,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56283,14 +89554,32 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56299,9 +89588,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56314,7 +89612,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56334,14 +89638,32 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56350,9 +89672,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56365,7 +89696,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56386,33 +89723,80 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the autosave.", "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56421,9 +89805,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56436,7 +89829,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56452,18 +89851,36 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56484,21 +89901,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -56512,14 +89940,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -56533,19 +89969,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56586,7 +90043,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56612,12 +90075,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56631,21 +90106,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -56659,21 +90145,34 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -56681,7 +90180,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -56710,12 +90218,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56726,16 +90244,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -56743,7 +90276,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56765,7 +90304,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -56774,7 +90316,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56793,12 +90341,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56818,10 +90378,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -56834,7 +90406,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56854,10 +90432,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -56870,7 +90460,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56890,10 +90486,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -56906,7 +90514,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56920,21 +90534,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -56948,49 +90573,71 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result set to comments assigned to specific user IDs. Requires authorisation.", "in": "query", "name": "author", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.", "in": "query", "name": "author_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to that from a specific author email. Requires authorisation.", "in": "query", "name": "author_email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit response to comments published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -57004,35 +90651,62 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by comment attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "post", "parent", "type"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "include", + "parent", + "post", + "type" + ] + } }, { "description": "Limit result set to comments of specific parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes specific parent IDs.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to comments assigned to specific post IDs.", "in": "query", "name": "post", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to comments assigned a specific status. Requires authorisation.", @@ -57058,7 +90732,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57069,22 +90749,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID of the user object, if author was a user.", "type": "integer" }, - "author_email": { "description": "Email address for the comment author.", "type": "string" }, - "author_ip": { "description": "IP address for the comment author.", "type": "string" }, - "author_name": { "description": "Display name for the comment author.", "type": "string" }, - "author_url": { "description": "URL for the comment author.", "type": "string" }, - "author_user_agent": { "description": "User agent for the comment author.", "type": "string" }, - "content": { "description": "The content for the comment.", "type": "object" }, + "author": { + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "type": "object" + }, "date": { "description": "The date the comment was published, in the site's time zone.", "type": "string" }, - "date_gmt": { "description": "The date the comment was published, as GMT.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the comment.", "type": "integer" }, - "post": { "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "description": "State of the comment.", "type": "string" } + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "type": "string" + } }, "type": "object" } @@ -57093,7 +90809,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57115,7 +90837,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" }, + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + }, "password": { "description": "The password for the parent post of the comment (if the post is password protected).", "type": "string" @@ -57128,7 +90853,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57147,7 +90878,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "The password for the parent post of the comment (if the post is password protected).", @@ -57159,7 +90896,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57179,22 +90922,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID of the user object, if author was a user.", "type": "integer" }, - "author_email": { "description": "Email address for the comment author.", "type": "string" }, - "author_ip": { "description": "IP address for the comment author.", "type": "string" }, - "author_name": { "description": "Display name for the comment author.", "type": "string" }, - "author_url": { "description": "URL for the comment author.", "type": "string" }, - "author_user_agent": { "description": "User agent for the comment author.", "type": "string" }, - "content": { "description": "The content for the comment.", "type": "object" }, + "author": { + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "type": "object" + }, "date": { "description": "The date the comment was published, in the site's time zone.", "type": "string" }, - "date_gmt": { "description": "The date the comment was published, as GMT.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the comment.", "type": "integer" }, - "post": { "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "description": "State of the comment.", "type": "string" } + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "type": "string" + } }, "type": "object" } @@ -57203,7 +90982,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57223,22 +91008,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID of the user object, if author was a user.", "type": "integer" }, - "author_email": { "description": "Email address for the comment author.", "type": "string" }, - "author_ip": { "description": "IP address for the comment author.", "type": "string" }, - "author_name": { "description": "Display name for the comment author.", "type": "string" }, - "author_url": { "description": "URL for the comment author.", "type": "string" }, - "author_user_agent": { "description": "User agent for the comment author.", "type": "string" }, - "content": { "description": "The content for the comment.", "type": "object" }, + "author": { + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "type": "object" + }, "date": { "description": "The date the comment was published, in the site's time zone.", "type": "string" }, - "date_gmt": { "description": "The date the comment was published, as GMT.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the comment.", "type": "integer" }, - "post": { "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "description": "State of the comment.", "type": "string" } + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "type": "string" + } }, "type": "object" } @@ -57247,7 +91068,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57267,22 +91094,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID of the user object, if author was a user.", "type": "integer" }, - "author_email": { "description": "Email address for the comment author.", "type": "string" }, - "author_ip": { "description": "IP address for the comment author.", "type": "string" }, - "author_name": { "description": "Display name for the comment author.", "type": "string" }, - "author_url": { "description": "URL for the comment author.", "type": "string" }, - "author_user_agent": { "description": "User agent for the comment author.", "type": "string" }, - "content": { "description": "The content for the comment.", "type": "object" }, + "author": { + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "type": "object" + }, "date": { "description": "The date the comment was published, in the site's time zone.", "type": "string" }, - "date_gmt": { "description": "The date the comment was published, as GMT.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the comment.", "type": "integer" }, - "post": { "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "description": "State of the comment.", "type": "string" } + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "type": "string" + } }, "type": "object" } @@ -57291,7 +91154,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57305,26 +91174,43 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/font-collection" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/font-collection" + } + } + }, "description": "OK" } } @@ -57338,13 +91224,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "slug", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/font-collection" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/font-collection" + } + } + }, "description": "OK" } } @@ -57358,35 +91262,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -57400,26 +91323,46 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include"] } + "schema": { + "enum": [ + "id", + "include" + ] + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57440,7 +91383,9 @@ "type": "integer" } }, - "required": ["font_family_settings"], + "required": [ + "font_family_settings" + ], "type": "object" } } @@ -57448,7 +91393,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57469,35 +91420,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -57511,19 +91481,35 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include"] } + "schema": { + "enum": [ + "id", + "include" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, "description": "OK" } } @@ -57553,7 +91539,9 @@ "type": "integer" } }, - "required": ["font_face_settings"], + "required": [ + "font_face_settings" + ], "type": "object" } } @@ -57561,7 +91549,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, "description": "OK" } } @@ -57590,7 +91584,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -57599,7 +91596,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, "description": "OK" } } @@ -57625,12 +91628,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, "description": "OK" } } @@ -57652,7 +91667,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -57661,7 +91679,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57680,12 +91704,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57715,7 +91751,9 @@ "type": "integer" } }, - "required": ["font_family_settings"], + "required": [ + "font_family_settings" + ], "type": "object" } } @@ -57723,7 +91761,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57753,7 +91797,9 @@ "type": "integer" } }, - "required": ["font_family_settings"], + "required": [ + "font_family_settings" + ], "type": "object" } } @@ -57761,7 +91807,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57791,7 +91843,9 @@ "type": "integer" } }, - "required": ["font_family_settings"], + "required": [ + "font_family_settings" + ], "type": "object" } } @@ -57799,7 +91853,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57808,41 +91868,97 @@ "/wp/v2/global-styles/themes/{stylesheet}": { "get": { "parameters": [ - { "description": "The theme identifier", "in": "path", "name": "stylesheet", "required": true, "schema": {} } + { + "description": "The theme identifier", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/global-styles/themes/{stylesheet}/variations": { "get": { "parameters": [ - { "description": "The theme identifier", "in": "path", "name": "stylesheet", "required": true, "schema": {} } + { + "description": "The theme identifier", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/global-styles/{id}": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, "description": "OK" } } }, "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "settings": { "description": "Global settings.", "type": ["object"] }, - "styles": { "description": "Global styles.", "type": ["object"] }, - "title": { "description": "Title of the global styles variation.", "type": ["object", "string"] } + "settings": { + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "description": "Global styles.", + "type": [ + "object" + ] + }, + "title": { + "description": "Title of the global styles variation.", + "type": [ + "object", + "string" + ] + } }, "type": "object" } @@ -57851,21 +91967,51 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "settings": { "description": "Global settings.", "type": ["object"] }, - "styles": { "description": "Global styles.", "type": ["object"] }, - "title": { "description": "Title of the global styles variation.", "type": ["object", "string"] } + "settings": { + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "description": "Global styles.", + "type": [ + "object" + ] + }, + "title": { + "description": "Title of the global styles variation.", + "type": [ + "object", + "string" + ] + } }, "type": "object" } @@ -57874,21 +92020,51 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "settings": { "description": "Global settings.", "type": ["object"] }, - "styles": { "description": "Global styles.", "type": ["object"] }, - "title": { "description": "Title of the global styles variation.", "type": ["object", "string"] } + "settings": { + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "description": "Global styles.", + "type": [ + "object" + ] + }, + "title": { + "description": "Title of the global styles variation.", + "type": [ + "object", + "string" + ] + } }, "type": "object" } @@ -57897,7 +92073,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, "description": "OK" } } @@ -57918,21 +92100,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -57945,7 +92138,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles-revision" + } + } }, "description": "OK" } @@ -57974,13 +92171,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles-revision" + } + } }, "description": "OK" } @@ -57995,21 +92202,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -58023,56 +92241,80 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result set to posts assigned to specific authors.", "in": "query", "name": "author", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes posts assigned to specific authors.", "in": "query", "name": "author_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -58086,7 +92328,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -58099,11 +92346,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ] } @@ -58113,42 +92360,78 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Array of column names to be searched.", "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", "in": "query", "name": "status", "required": false, - "schema": { "items": { "enum": ["inherit", "private", "trash"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "inherit", + "private", + "trash" + ], + "type": "string" + } + } }, { "description": "Limit result set to attachments of a particular media type.", "in": "query", "name": "media_type", "required": false, - "schema": { "enum": ["image", "video", "application"] } + "schema": { + "enum": [ + "application", + "image", + "video" + ] + } }, { "description": "Limit result set to attachments of a particular MIME type.", @@ -58160,7 +92443,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58175,29 +92464,68 @@ "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, - "author": { "description": "The ID for the author of the post.", "type": "integer" }, - "caption": { "description": "The attachment caption.", "type": "object" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "description": "The attachment caption.", + "type": "object" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "The attachment description.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, + "post": { + "description": "The ID for the associated post of the attachment.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "description": { "description": "The attachment description.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, - "post": { "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -58206,7 +92534,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58228,7 +92562,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -58237,7 +92574,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58256,12 +92599,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58285,29 +92640,68 @@ "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, - "author": { "description": "The ID for the author of the post.", "type": "integer" }, - "caption": { "description": "The attachment caption.", "type": "object" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "description": "The attachment caption.", + "type": "object" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "The attachment description.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, + "post": { + "description": "The ID for the associated post of the attachment.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "description": { "description": "The attachment description.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, - "post": { "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -58316,7 +92710,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58340,29 +92740,68 @@ "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, - "author": { "description": "The ID for the author of the post.", "type": "integer" }, - "caption": { "description": "The attachment caption.", "type": "object" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "description": "The attachment caption.", + "type": "object" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "The attachment description.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, + "post": { + "description": "The ID for the associated post of the attachment.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "description": { "description": "The attachment description.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, - "post": { "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -58371,7 +92810,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58395,29 +92840,68 @@ "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, - "author": { "description": "The ID for the author of the post.", "type": "integer" }, - "caption": { "description": "The attachment caption.", "type": "object" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "description": "The attachment caption.", + "type": "object" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "The attachment description.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, + "post": { + "description": "The ID for the associated post of the attachment.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "description": { "description": "The attachment description.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, - "post": { "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -58426,7 +92910,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58434,7 +92924,15 @@ }, "/wp/v2/media/{id}/edit": { "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -58444,12 +92942,19 @@ "description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead.", "type": "number" }, - "modifiers": { "description": "Array of image edits.", "type": "array" }, + "modifiers": { + "description": "Array of image edits.", + "type": "array" + }, "rotation": { "description": "The amount to rotate the image clockwise in degrees. DEPRECATED: use `modifiers` instead.", "type": "integer" }, - "src": { "description": "URL to the edited image file.", "required": true, "type": "string" }, + "src": { + "description": "URL to the edited image file.", + "required": true, + "type": "string" + }, "width": { "description": "As a percentage of the image, the width to which to crop the image. DEPRECATED: use `modifiers` instead.", "type": "number" @@ -58463,13 +92968,19 @@ "type": "number" } }, - "required": ["src"], + "required": [ + "src" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/media/{id}/post-process": { @@ -58487,14 +92998,25 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "action": { "required": true, "type": "string" } }, - "required": ["action"], + "properties": { + "action": { + "required": true, + "type": "string" + } + }, + "required": [ + "action" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/menu-items": { @@ -58505,21 +93027,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -58533,42 +93066,58 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -58582,7 +93131,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -58595,13 +93149,13 @@ "date", "id", "include", + "include_slugs", + "menu_order", "modified", "parent", "relevance", "slug", - "include_slugs", - "title", - "menu_order" + "title" ] } }, @@ -58610,14 +93164,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -58627,27 +93194,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -58658,7 +93225,12 @@ "in": "query", "name": "tax_relation", "required": false, - "schema": { "enum": ["AND", "OR"] } + "schema": { + "enum": [ + "AND", + "OR" + ] + } }, { "description": "Limit result set to items with specific terms assigned in the menus taxonomy.", @@ -58669,7 +93241,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -58680,13 +93254,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -58705,7 +93284,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -58716,7 +93297,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -58736,7 +93319,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58751,8 +93340,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -58761,7 +93356,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -58770,18 +93368,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -58794,7 +93407,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58816,7 +93435,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -58825,7 +93447,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58844,12 +93472,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58873,8 +93513,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -58883,7 +93529,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -58892,18 +93541,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -58916,7 +93580,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58940,8 +93610,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -58950,7 +93626,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -58959,18 +93638,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -58983,7 +93677,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -59007,8 +93707,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -59017,7 +93723,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -59026,18 +93735,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -59050,7 +93774,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -59071,21 +93801,45 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -59095,8 +93849,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -59105,7 +93865,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -59114,18 +93877,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -59139,7 +93917,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } }, "description": "OK" } @@ -59156,19 +93938,35 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } }, "description": "OK" } @@ -59183,12 +93981,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/menu-location" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/menu-location" + } + } + }, "description": "OK" } } @@ -59209,12 +94019,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/menu-location" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/menu-location" + } + } + }, "description": "OK" } } @@ -59228,21 +94050,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -59256,14 +94089,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -59277,7 +94118,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -59285,7 +94131,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -59307,12 +94162,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59327,16 +94192,31 @@ "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, - "description": { "description": "HTML description of the term.", "type": "string" }, - "locations": { "description": "The locations assigned to the menu.", "type": "array" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "locations": { + "description": "The locations assigned to the menu.", + "type": "array" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -59344,7 +94224,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59366,7 +94252,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -59375,7 +94264,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59394,12 +94289,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59423,10 +94330,22 @@ "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, - "description": { "description": "HTML description of the term.", "type": "string" }, - "locations": { "description": "The locations assigned to the menu.", "type": "array" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "locations": { + "description": "The locations assigned to the menu.", + "type": "array" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -59439,7 +94358,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59463,10 +94388,22 @@ "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, - "description": { "description": "HTML description of the term.", "type": "string" }, - "locations": { "description": "The locations assigned to the menu.", "type": "array" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "locations": { + "description": "The locations assigned to the menu.", + "type": "array" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -59479,7 +94416,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59503,10 +94446,22 @@ "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, - "description": { "description": "HTML description of the term.", "type": "string" }, - "locations": { "description": "The locations assigned to the menu.", "type": "array" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "locations": { + "description": "The locations assigned to the menu.", + "type": "array" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -59519,7 +94474,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59533,21 +94494,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -59561,42 +94533,58 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -59610,7 +94598,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -59623,11 +94616,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ] } @@ -59637,14 +94630,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -59654,27 +94660,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -59683,7 +94689,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59694,12 +94706,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59708,9 +94732,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59719,7 +94752,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59741,7 +94780,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -59750,7 +94792,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59769,7 +94817,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "The password for the post if it is password protected.", @@ -59781,7 +94835,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59801,12 +94861,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59815,9 +94887,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59826,7 +94907,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59846,12 +94933,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59860,9 +94959,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59871,7 +94979,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59891,12 +95005,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59905,9 +95031,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59916,7 +95051,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59937,33 +95078,72 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "parent": { "description": "The ID for the parent of the autosave.", "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59972,9 +95152,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59984,7 +95173,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60001,19 +95194,35 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60035,21 +95244,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -60063,14 +95283,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -60084,20 +95312,39 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60140,7 +95387,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60167,13 +95418,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60188,21 +95449,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -60216,56 +95488,80 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result set to posts assigned to specific authors.", "in": "query", "name": "author", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes posts assigned to specific authors.", "in": "query", "name": "author_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to posts with a specific menu_order value.", @@ -60286,7 +95582,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -60299,13 +95600,13 @@ "date", "id", "include", + "include_slugs", + "menu_order", "modified", "parent", "relevance", "slug", - "include_slugs", - "title", - "menu_order" + "title" ] } }, @@ -60314,28 +95615,49 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Array of column names to be searched.", "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -60345,27 +95667,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -60374,7 +95696,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60385,37 +95713,76 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60424,7 +95791,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60446,7 +95819,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -60455,7 +95831,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60474,7 +95856,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Override the default excerpt length.", @@ -60493,7 +95881,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60513,37 +95907,76 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60552,7 +95985,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60572,37 +96011,76 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60611,7 +96089,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60631,37 +96115,76 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60670,7 +96193,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60691,55 +96220,120 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60748,7 +96342,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60764,18 +96364,36 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60796,21 +96414,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -60824,14 +96453,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -60845,19 +96482,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60898,7 +96556,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60924,12 +96588,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60943,42 +96619,59 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", "in": "query", "name": "search", "required": false, - "schema": { "minLength": 1 } + "schema": { + "minLength": 1 + } }, { "description": "Limit results to those matching a category ID.", "in": "query", "name": "category", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Limit results to those matching a keyword ID.", "in": "query", "name": "keyword", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Limit results to those matching a pattern (slug).", @@ -60999,7 +96692,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -61010,15 +96708,15 @@ "enum": [ "author", "date", + "favorite_count", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", - "title", - "favorite_count" + "title" ] } } @@ -61026,7 +96724,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/pattern-directory-item" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/pattern-directory-item" + } + } }, "description": "OK" } @@ -61041,7 +96743,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Limit results to those matching a string.", @@ -61055,12 +96763,26 @@ "in": "query", "name": "status", "required": false, - "schema": { "items": { "enum": ["inactive", "active"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } @@ -61071,10 +96793,19 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "slug": { "description": "WordPress.org plugin directory slug.", "required": true, "type": "string" }, - "status": { "description": "The plugin activation status.", "type": "string" } + "slug": { + "description": "WordPress.org plugin directory slug.", + "required": true, + "type": "string" + }, + "status": { + "description": "The plugin activation status.", + "type": "string" + } }, - "required": ["slug"], + "required": [ + "slug" + ], "type": "object" } } @@ -61082,7 +96813,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } @@ -61090,7 +96827,15 @@ }, "/wp/v2/plugins/{plugin}": { "delete": { - "parameters": [{ "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -61108,7 +96853,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } @@ -61120,19 +96871,45 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } }, "patch": { - "parameters": [{ "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -61142,7 +96919,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "status": { "description": "The plugin activation status.", "type": "string" } + "status": { + "description": "The plugin activation status.", + "type": "string" + } }, "type": "object" } @@ -61151,13 +96931,27 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -61167,7 +96961,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "status": { "description": "The plugin activation status.", "type": "string" } + "status": { + "description": "The plugin activation status.", + "type": "string" + } }, "type": "object" } @@ -61176,13 +96973,27 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -61192,7 +97003,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "status": { "description": "The plugin activation status.", "type": "string" } + "status": { + "description": "The plugin activation status.", + "type": "string" + } }, "type": "object" } @@ -61201,7 +97015,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } @@ -61215,21 +97035,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -61243,56 +97074,80 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result set to posts assigned to specific authors.", "in": "query", "name": "author", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes posts assigned to specific authors.", "in": "query", "name": "author_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -61306,7 +97161,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -61319,11 +97179,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ] } @@ -61333,14 +97193,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -61350,27 +97223,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -61381,7 +97254,12 @@ "in": "query", "name": "tax_relation", "required": false, - "schema": { "enum": ["AND", "OR"] } + "schema": { + "enum": [ + "AND", + "OR" + ] + } }, { "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", @@ -61392,7 +97270,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -61408,13 +97288,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -61433,7 +97318,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -61449,7 +97336,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -61468,7 +97357,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -61479,13 +97370,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -61504,7 +97400,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -61515,7 +97413,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -61535,7 +97435,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61546,7 +97452,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61555,26 +97464,56 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61583,8 +97522,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61593,7 +97538,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61615,7 +97566,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -61624,7 +97578,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61643,7 +97603,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Override the default excerpt length.", @@ -61662,7 +97628,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61682,7 +97654,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61691,26 +97666,56 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61719,8 +97724,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61729,7 +97740,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61749,7 +97766,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61758,26 +97778,56 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61786,8 +97836,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61796,7 +97852,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61816,7 +97878,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61825,26 +97890,56 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61853,8 +97948,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61863,7 +97964,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61884,25 +97991,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61911,27 +98047,60 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the autosave.", "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61940,8 +98109,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61950,7 +98125,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -61966,18 +98147,36 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -61998,21 +98197,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -62026,14 +98236,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -62047,19 +98265,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -62100,7 +98339,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -62126,12 +98371,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -62145,21 +98402,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -62173,42 +98441,58 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -62222,7 +98506,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -62235,16 +98524,16 @@ "date", "id", "include", + "include_slugs", "modified", "parent", - "relevance", - "slug", - "include_slugs", - "title", + "popularity", "popularity", "rating", - "popularity", - "rating" + "rating", + "relevance", + "slug", + "title" ] } }, @@ -62253,14 +98542,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -62270,27 +98572,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -62301,7 +98603,12 @@ "in": "query", "name": "tax_relation", "required": false, - "schema": { "enum": ["AND", "OR"] } + "schema": { + "enum": [ + "AND", + "OR" + ] + } }, { "description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.", @@ -62312,7 +98619,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -62328,13 +98637,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -62353,7 +98667,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -62369,7 +98685,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -62388,7 +98706,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -62399,13 +98719,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -62424,7 +98749,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -62435,7 +98762,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -62448,7 +98777,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62459,15 +98794,36 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62484,9 +98840,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62495,7 +98860,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62517,7 +98888,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -62526,7 +98900,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62545,7 +98925,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Override the default excerpt length.", @@ -62564,7 +98950,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62584,15 +98976,36 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62609,9 +99022,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62620,7 +99042,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62640,15 +99068,36 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62665,9 +99114,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62676,7 +99134,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62696,15 +99160,36 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62721,9 +99206,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62732,7 +99226,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62753,34 +99253,84 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the autosave.", "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62797,9 +99347,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62808,7 +99367,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, "description": "OK" } } @@ -62824,18 +99389,36 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, "description": "OK" } } @@ -62849,21 +99432,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -62877,21 +99471,34 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -62899,7 +99506,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -62928,12 +99544,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -62944,16 +99570,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -62961,7 +99602,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -62983,7 +99630,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -62992,7 +99642,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63011,12 +99667,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63036,10 +99704,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63052,7 +99732,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63072,10 +99758,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63088,7 +99786,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63108,10 +99812,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63124,7 +99840,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63138,21 +99860,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -63166,14 +99899,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -63187,7 +99928,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -63195,7 +99941,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -63217,12 +99972,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63233,15 +99998,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -63249,7 +100026,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63271,7 +100054,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -63280,7 +100066,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63299,12 +100091,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63324,9 +100128,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63339,7 +100152,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63359,9 +100178,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63374,7 +100202,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63394,9 +100228,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63409,7 +100252,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63423,21 +100272,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed"] } + "schema": { + "enum": [ + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -63451,7 +100310,13 @@ "in": "query", "name": "type", "required": false, - "schema": { "enum": ["post", "term", "post-format"] } + "schema": { + "enum": [ + "post", + "post-format", + "term" + ] + } }, { "description": "Limit results to items of one or more object subtypes.", @@ -63460,7 +100325,16 @@ "required": false, "schema": { "items": { - "enum": ["post", "page", "product", "category", "post_tag", "product_cat", "product_tag", "any"], + "enum": [ + "any", + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], "type": "string" } } @@ -63470,19 +100344,33 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search-result" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/search-result" + } + } + }, "description": "OK" } } @@ -63492,7 +100380,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, "description": "OK" } } @@ -63503,8 +100397,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "date_format": { "description": "A date format for all date strings.", "type": "string" }, - "default_category": { "description": "Default post category.", "type": "integer" }, + "date_format": { + "description": "A date format for all date strings.", + "type": "string" + }, + "default_category": { + "description": "Default post category.", + "type": "integer" + }, "default_comment_status": { "description": "Allow people to submit comments on new posts.", "type": "string" @@ -63513,13 +100413,22 @@ "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", "type": "string" }, - "default_post_format": { "description": "Default post format.", "type": "string" }, - "description": { "description": "Site tagline.", "type": "string" }, + "default_post_format": { + "description": "Default post format.", + "type": "string" + }, + "description": { + "description": "Site tagline.", + "type": "string" + }, "email": { "description": "This address is used for admin purposes, like new user notification.", "type": "string" }, - "language": { "description": "WordPress locale code.", "type": "string" }, + "language": { + "description": "WordPress locale code.", + "type": "string" + }, "page_for_posts": { "description": "The ID of the page that should display the latest posts", "type": "integer" @@ -63532,19 +100441,46 @@ "description": "WooCommerce Local Pickup Method Settings", "type": "object" }, - "pickup_locations": { "description": "WooCommerce Local Pickup Locations", "type": "array" }, - "posts_per_page": { "description": "Blog pages show at most.", "type": "integer" }, - "show_on_front": { "description": "What to show on the front page", "type": "string" }, - "site_icon": { "description": "Site icon.", "type": "integer" }, - "site_logo": { "description": "Site logo.", "type": "integer" }, + "pickup_locations": { + "description": "WooCommerce Local Pickup Locations", + "type": "array" + }, + "posts_per_page": { + "description": "Blog pages show at most.", + "type": "integer" + }, + "show_on_front": { + "description": "What to show on the front page", + "type": "string" + }, + "site_icon": { + "description": "Site icon.", + "type": "integer" + }, + "site_logo": { + "description": "Site logo.", + "type": "integer" + }, "start_of_week": { "description": "A day number of the week that the week should start on.", "type": "integer" }, - "time_format": { "description": "A time format for all time strings.", "type": "string" }, - "timezone": { "description": "A city in the same timezone as you.", "type": "string" }, - "title": { "description": "Site title.", "type": "string" }, - "url": { "description": "Site URL.", "type": "string" }, + "time_format": { + "description": "A time format for all time strings.", + "type": "string" + }, + "timezone": { + "description": "A city in the same timezone as you.", + "type": "string" + }, + "title": { + "description": "Site title.", + "type": "string" + }, + "url": { + "description": "Site URL.", + "type": "string" + }, "use_smilies": { "description": "Convert emoticons like :-) and :-P to graphics on display.", "type": "boolean" @@ -63557,7 +100493,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, "description": "OK" } } @@ -63568,8 +100510,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "date_format": { "description": "A date format for all date strings.", "type": "string" }, - "default_category": { "description": "Default post category.", "type": "integer" }, + "date_format": { + "description": "A date format for all date strings.", + "type": "string" + }, + "default_category": { + "description": "Default post category.", + "type": "integer" + }, "default_comment_status": { "description": "Allow people to submit comments on new posts.", "type": "string" @@ -63578,13 +100526,22 @@ "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", "type": "string" }, - "default_post_format": { "description": "Default post format.", "type": "string" }, - "description": { "description": "Site tagline.", "type": "string" }, + "default_post_format": { + "description": "Default post format.", + "type": "string" + }, + "description": { + "description": "Site tagline.", + "type": "string" + }, "email": { "description": "This address is used for admin purposes, like new user notification.", "type": "string" }, - "language": { "description": "WordPress locale code.", "type": "string" }, + "language": { + "description": "WordPress locale code.", + "type": "string" + }, "page_for_posts": { "description": "The ID of the page that should display the latest posts", "type": "integer" @@ -63597,19 +100554,46 @@ "description": "WooCommerce Local Pickup Method Settings", "type": "object" }, - "pickup_locations": { "description": "WooCommerce Local Pickup Locations", "type": "array" }, - "posts_per_page": { "description": "Blog pages show at most.", "type": "integer" }, - "show_on_front": { "description": "What to show on the front page", "type": "string" }, - "site_icon": { "description": "Site icon.", "type": "integer" }, - "site_logo": { "description": "Site logo.", "type": "integer" }, + "pickup_locations": { + "description": "WooCommerce Local Pickup Locations", + "type": "array" + }, + "posts_per_page": { + "description": "Blog pages show at most.", + "type": "integer" + }, + "show_on_front": { + "description": "What to show on the front page", + "type": "string" + }, + "site_icon": { + "description": "Site icon.", + "type": "integer" + }, + "site_logo": { + "description": "Site logo.", + "type": "integer" + }, "start_of_week": { "description": "A day number of the week that the week should start on.", "type": "integer" }, - "time_format": { "description": "A time format for all time strings.", "type": "string" }, - "timezone": { "description": "A city in the same timezone as you.", "type": "string" }, - "title": { "description": "Site title.", "type": "string" }, - "url": { "description": "Site URL.", "type": "string" }, + "time_format": { + "description": "A time format for all time strings.", + "type": "string" + }, + "timezone": { + "description": "A city in the same timezone as you.", + "type": "string" + }, + "title": { + "description": "Site title.", + "type": "string" + }, + "url": { + "description": "Site URL.", + "type": "string" + }, "use_smilies": { "description": "Convert emoticons like :-) and :-P to graphics on display.", "type": "boolean" @@ -63622,7 +100606,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, "description": "OK" } } @@ -63633,8 +100623,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "date_format": { "description": "A date format for all date strings.", "type": "string" }, - "default_category": { "description": "Default post category.", "type": "integer" }, + "date_format": { + "description": "A date format for all date strings.", + "type": "string" + }, + "default_category": { + "description": "Default post category.", + "type": "integer" + }, "default_comment_status": { "description": "Allow people to submit comments on new posts.", "type": "string" @@ -63643,13 +100639,22 @@ "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", "type": "string" }, - "default_post_format": { "description": "Default post format.", "type": "string" }, - "description": { "description": "Site tagline.", "type": "string" }, + "default_post_format": { + "description": "Default post format.", + "type": "string" + }, + "description": { + "description": "Site tagline.", + "type": "string" + }, "email": { "description": "This address is used for admin purposes, like new user notification.", "type": "string" }, - "language": { "description": "WordPress locale code.", "type": "string" }, + "language": { + "description": "WordPress locale code.", + "type": "string" + }, "page_for_posts": { "description": "The ID of the page that should display the latest posts", "type": "integer" @@ -63662,19 +100667,46 @@ "description": "WooCommerce Local Pickup Method Settings", "type": "object" }, - "pickup_locations": { "description": "WooCommerce Local Pickup Locations", "type": "array" }, - "posts_per_page": { "description": "Blog pages show at most.", "type": "integer" }, - "show_on_front": { "description": "What to show on the front page", "type": "string" }, - "site_icon": { "description": "Site icon.", "type": "integer" }, - "site_logo": { "description": "Site logo.", "type": "integer" }, + "pickup_locations": { + "description": "WooCommerce Local Pickup Locations", + "type": "array" + }, + "posts_per_page": { + "description": "Blog pages show at most.", + "type": "integer" + }, + "show_on_front": { + "description": "What to show on the front page", + "type": "string" + }, + "site_icon": { + "description": "Site icon.", + "type": "integer" + }, + "site_logo": { + "description": "Site logo.", + "type": "integer" + }, "start_of_week": { "description": "A day number of the week that the week should start on.", "type": "integer" }, - "time_format": { "description": "A time format for all time strings.", "type": "string" }, - "timezone": { "description": "A city in the same timezone as you.", "type": "string" }, - "title": { "description": "Site title.", "type": "string" }, - "url": { "description": "Site URL.", "type": "string" }, + "time_format": { + "description": "A time format for all time strings.", + "type": "string" + }, + "timezone": { + "description": "A city in the same timezone as you.", + "type": "string" + }, + "title": { + "description": "Site title.", + "type": "string" + }, + "url": { + "description": "Site URL.", + "type": "string" + }, "use_smilies": { "description": "Convert emoticons like :-) and :-P to graphics on display.", "type": "boolean" @@ -63687,7 +100719,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, "description": "OK" } } @@ -63701,12 +100739,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } @@ -63727,23 +100777,48 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } }, "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "widgets": { "description": "Nested widgets.", "type": "array" } }, + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, "type": "object" } } @@ -63751,18 +100826,37 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "widgets": { "description": "Nested widgets.", "type": "array" } }, + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, "type": "object" } } @@ -63770,18 +100864,37 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "widgets": { "description": "Nested widgets.", "type": "array" } }, + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, "type": "object" } } @@ -63789,7 +100902,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } @@ -63803,12 +100922,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status" + } + } + }, "description": "OK" } } @@ -63829,12 +100960,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status" + } + } + }, "description": "OK" } } @@ -63848,21 +100991,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -63876,14 +101030,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -63897,7 +101059,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -63905,7 +101072,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -63927,12 +101103,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -63943,15 +101129,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -63959,7 +101157,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -63981,7 +101185,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -63990,7 +101197,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64009,12 +101222,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64034,9 +101259,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -64049,7 +101283,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64069,9 +101309,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -64084,7 +101333,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64104,9 +101359,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -64119,7 +101383,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64133,7 +101403,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Limit results to taxonomies associated with a specific post type.", @@ -64145,7 +101421,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxonomy" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taxonomy" + } + } + }, "description": "OK" } } @@ -64166,12 +101448,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxonomy" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taxonomy" + } + } + }, "description": "OK" } } @@ -64185,7 +101479,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Limit to the specified post ID.", @@ -64211,7 +101511,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64226,20 +101532,49 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, "slug": { "description": "Unique slug identifying the template.", "required": true, "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, - "required": ["slug"], + "required": [ + "slug" + ], "type": "object" } } @@ -64247,7 +101582,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64278,20 +101619,33 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/template-parts/{id}": { "delete": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -64300,32 +101654,62 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -64336,14 +101720,44 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64352,14 +101766,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -64370,14 +101796,44 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64386,14 +101842,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -64404,14 +101872,44 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64420,7 +101918,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64429,25 +101933,49 @@ "/wp/v2/template-parts/{id}/autosaves": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -64458,14 +101986,44 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64474,7 +102032,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64483,19 +102047,43 @@ "/wp/v2/template-parts/{parent}/autosaves/{id}": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64504,27 +102092,44 @@ "/wp/v2/template-parts/{parent}/revisions": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -64538,14 +102143,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -64559,19 +102172,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64580,7 +102214,13 @@ "/wp/v2/template-parts/{parent}/revisions/{id}": { "delete": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the revision.", "in": "path", @@ -64606,14 +102246,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the revision.", "in": "path", @@ -64626,12 +102278,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64645,7 +102309,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Limit to the specified post ID.", @@ -64671,7 +102341,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64682,20 +102358,49 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, "slug": { "description": "Unique slug identifying the template.", "required": true, "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, - "required": ["slug"], + "required": [ + "slug" + ], "type": "object" } } @@ -64703,7 +102408,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64734,20 +102445,33 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/templates/{id}": { "delete": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -64756,46 +102480,106 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64804,28 +102588,70 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64834,28 +102660,70 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64864,7 +102732,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64873,39 +102747,93 @@ "/wp/v2/templates/{id}/autosaves": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64914,7 +102842,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64923,19 +102857,43 @@ "/wp/v2/templates/{parent}/autosaves/{id}": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64944,27 +102902,44 @@ "/wp/v2/templates/{parent}/revisions": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -64978,14 +102953,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -64999,19 +102982,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -65020,7 +103024,13 @@ "/wp/v2/templates/{parent}/revisions/{id}": { "delete": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the revision.", "in": "path", @@ -65046,14 +103056,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the revision.", "in": "path", @@ -65066,12 +103088,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -65085,12 +103119,26 @@ "in": "query", "name": "status", "required": false, - "schema": { "items": { "enum": ["active", "inactive"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/theme" + } + } + }, "description": "OK" } } @@ -65109,7 +103157,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/theme" + } + } + }, "description": "OK" } } @@ -65123,12 +103177,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/type" + } + } + }, "description": "OK" } } @@ -65149,12 +103215,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/type" + } + } + }, "description": "OK" } } @@ -65168,21 +103246,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -65196,14 +103285,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -65217,42 +103314,74 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by user attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url"] } + "schema": { + "enum": [ + "email", + "id", + "include", + "include_slugs", + "name", + "registered_date", + "slug", + "url" + ] + } }, { "description": "Limit result set to users with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "in": "query", "name": "roles", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", "in": "query", "name": "capabilities", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to users who are considered authors.", "in": "query", "name": "who", "required": false, - "schema": { "enum": ["authors"] } + "schema": { + "enum": [ + "authors" + ] + } }, { "description": "Limit result set to users who have published posts.", @@ -65282,7 +103411,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65293,25 +103428,67 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "required": true, "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, "password": { "description": "Password for the user (never included).", "required": true, "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "required": true, "type": "string" } + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "required": true, + "type": "string" + } }, - "required": ["username", "email", "password"], + "required": [ + "email", + "password", + "username" + ], "type": "object" } } @@ -65319,7 +103496,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65342,7 +103525,9 @@ "type": "integer" } }, - "required": ["reassign"], + "required": [ + "reassign" + ], "type": "object" } } @@ -65350,7 +103535,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65362,12 +103553,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65378,19 +103581,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65399,7 +103641,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65410,19 +103658,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65431,7 +103718,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65442,19 +103735,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65463,7 +103795,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65495,7 +103833,9 @@ "type": "integer" } }, - "required": ["reassign"], + "required": [ + "reassign" + ], "type": "object" } } @@ -65503,7 +103843,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65522,12 +103868,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65547,19 +103905,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65568,7 +103965,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65588,19 +103991,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65609,7 +104051,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65629,19 +104077,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65650,7 +104137,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65658,10 +104151,24 @@ }, "/wp/v2/users/{user_id}/application-passwords": { "delete": { - "parameters": [{ "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65673,19 +104180,45 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -65695,9 +104228,15 @@ "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "type": "string" }, - "name": { "description": "The name of the application password.", "required": true, "type": "string" } + "name": { + "description": "The name of the application password.", + "required": true, + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -65705,7 +104244,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65719,13 +104264,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65734,12 +104297,30 @@ "/wp/v2/users/{user_id}/application-passwords/{uuid}": { "delete": { "parameters": [ - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65751,22 +104332,58 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -65777,7 +104394,10 @@ "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "type": "string" }, - "name": { "description": "The name of the application password.", "type": "string" } + "name": { + "description": "The name of the application password.", + "type": "string" + } }, "type": "object" } @@ -65786,15 +104406,33 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -65805,7 +104443,10 @@ "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "type": "string" }, - "name": { "description": "The name of the application password.", "type": "string" } + "name": { + "description": "The name of the application password.", + "type": "string" + } }, "type": "object" } @@ -65814,15 +104455,33 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -65833,7 +104492,10 @@ "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "type": "string" }, - "name": { "description": "The name of the application password.", "type": "string" } + "name": { + "description": "The name of the application password.", + "type": "string" + } }, "type": "object" } @@ -65842,7 +104504,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65856,12 +104524,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget-type" + } + } + }, "description": "OK" } } @@ -65870,18 +104550,36 @@ "/wp/v2/widget-types/{id}": { "get": { "parameters": [ - { "description": "The widget type ID.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The widget type ID.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget-type" + } + } + }, "description": "OK" } } @@ -65890,7 +104588,13 @@ "/wp/v2/widget-types/{id}/encode": { "post": { "parameters": [ - { "description": "The widget type ID.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The widget type ID.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -65901,34 +104605,54 @@ "description": "Serialised widget form data to encode into instance settings.", "type": "string" }, - "instance": { "description": "Current instance settings of the widget.", "type": "object" } + "instance": { + "description": "Current instance settings of the widget.", + "type": "object" + } }, "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/widget-types/{id}/render": { "post": { "parameters": [ - { "description": "The widget type ID.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The widget type ID.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "instance": { "description": "Current instance settings of the widget.", "type": "object" } + "instance": { + "description": "Current instance settings of the widget.", + "type": "object" + } }, "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/widgets": { @@ -65939,7 +104663,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "The sidebar for which to return widgets.", @@ -65951,7 +104681,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -65966,19 +104702,27 @@ "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", "type": "string" }, - "id": { "description": "Unique identifier for the widget.", "type": "string" }, + "id": { + "description": "Unique identifier for the widget.", + "type": "string" + }, "id_base": { "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, - "instance": { "description": "Instance settings of the widget, if supported.", "type": "object" }, + "instance": { + "description": "Instance settings of the widget, if supported.", + "type": "object" + }, "sidebar": { "description": "The sidebar to which the widget belongs.", "required": true, "type": "string" } }, - "required": ["sidebar"], + "required": [ + "sidebar" + ], "type": "object" } } @@ -65986,7 +104730,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -65994,7 +104744,15 @@ }, "/wp/v2/widgets/{id}": { "delete": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -66012,7 +104770,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66024,13 +104788,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66058,8 +104840,14 @@ "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, - "instance": { "description": "Instance settings of the widget, if supported.", "type": "object" }, - "sidebar": { "description": "The sidebar to which the widget belongs.", "type": "string" } + "instance": { + "description": "Instance settings of the widget, if supported.", + "type": "object" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } }, "type": "object" } @@ -66068,7 +104856,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66096,8 +104890,14 @@ "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, - "instance": { "description": "Instance settings of the widget, if supported.", "type": "object" }, - "sidebar": { "description": "The sidebar to which the widget belongs.", "type": "string" } + "instance": { + "description": "Instance settings of the widget, if supported.", + "type": "object" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } }, "type": "object" } @@ -66106,7 +104906,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66134,8 +104940,14 @@ "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, - "instance": { "description": "Instance settings of the widget, if supported.", "type": "object" }, - "sidebar": { "description": "The sidebar to which the widget belongs.", "type": "string" } + "instance": { + "description": "Instance settings of the widget, if supported.", + "type": "object" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } }, "type": "object" } @@ -66144,7 +104956,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66158,21 +104976,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -66186,14 +105015,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -66207,7 +105044,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -66215,7 +105057,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -66237,12 +105088,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66253,15 +105114,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -66269,7 +105142,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66291,7 +105170,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -66300,7 +105182,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66319,12 +105207,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66344,9 +105244,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -66359,7 +105268,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66379,9 +105294,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -66394,7 +105318,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66414,9 +105344,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -66429,7 +105368,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66437,23 +105382,75 @@ } }, "security": [], - "servers": [{ "url": "https:/haikuatelier.fr.ddev.site/wp-json" }], + "servers": [ + { + "url": "https:/haikuatelier.fr.ddev.site/wp-json" + } + ], "tags": [ - { "description": "", "name": "wc/v3" }, - { "description": "", "name": "wp-openapi/v1" }, - { "description": "", "name": "jetpack/v4" }, - { "description": "", "name": "wc-admin" }, - { "description": "", "name": "wc-analytics" }, - { "description": "", "name": "wc/store" }, - { "description": "", "name": "wc/store/v1" }, - { "description": "", "name": "wc/private" }, - { "description": "", "name": "wc/v1" }, - { "description": "", "name": "wc/v2" }, - { "description": "", "name": "wc-telemetry" }, - { "description": "", "name": "wccom-site/v3" }, - { "description": "", "name": "carbon-fields/v1" }, - { "description": "", "name": "wp/v2" }, - { "description": "", "name": "wp-site-health/v1" }, - { "description": "", "name": "wp-block-editor/v1" } + { + "description": "", + "name": "wc/v3" + }, + { + "description": "", + "name": "wp-openapi/v1" + }, + { + "description": "", + "name": "jetpack/v4" + }, + { + "description": "", + "name": "wc-admin" + }, + { + "description": "", + "name": "wc-analytics" + }, + { + "description": "", + "name": "wc/store" + }, + { + "description": "", + "name": "wc/store/v1" + }, + { + "description": "", + "name": "wc/private" + }, + { + "description": "", + "name": "wc/v1" + }, + { + "description": "", + "name": "wc/v2" + }, + { + "description": "", + "name": "wc-telemetry" + }, + { + "description": "", + "name": "wccom-site/v3" + }, + { + "description": "", + "name": "carbon-fields/v1" + }, + { + "description": "", + "name": "wp/v2" + }, + { + "description": "", + "name": "wp-site-health/v1" + }, + { + "description": "", + "name": "wp-block-editor/v1" + } ] } diff --git a/lib/wp-json-openapi.json b/lib/wp-json-openapi.json index 7fc1a6b0..11f08a0d 100755 --- a/lib/wp-json-openapi.json +++ b/lib/wp-json-openapi.json @@ -3,7 +3,12 @@ "schemas": { "Count Low in Stock Items": { "$schema": "http:/json-schema.org/draft-04/schema#", - "properties": { "properties": { "total": "integer" }, "type": "object" }, + "properties": { + "properties": { + "total": "integer" + }, + "type": "object" + }, "title": "Count Low in Stock Items", "type": "object" }, @@ -12,7 +17,14 @@ "properties": { "properties": { "job_id": "integer", - "status": { "enum": ["pending", "complete", "failed"], "type": "string" } + "status": { + "enum": [ + "complete", + "failed", + "pending" + ], + "type": "string" + } }, "type": "object" }, @@ -25,18 +37,40 @@ "properties": { "activate": { "properties": { - "activated": { "items": { "type": "string" }, "type": "array" }, - "active": { "items": { "type": "string" }, "type": "array" }, + "activated": { + "items": { + "type": "string" + }, + "type": "array" + }, + "active": { + "items": { + "type": "string" + }, + "type": "array" + }, "errors": { "properties": { "error_data": { - "items": { "type": "string" }, - "patternProperties": { "^.*$": { "type": "string" } }, + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, "type": "object" }, "errors": { - "items": { "type": "string" }, - "patternProperties": { "^.*$": { "type": "string" } }, + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, "type": "object" } }, @@ -50,20 +84,42 @@ "errors": { "properties": { "error_data": { - "items": { "type": "string" }, - "patternProperties": { "^.*$": { "type": "string" } }, + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, "type": "object" }, "errors": { - "items": { "type": "string" }, - "patternProperties": { "^.*$": { "type": "string" } }, + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, "type": "object" } }, "type": "object" }, - "installed": { "items": { "type": "string" }, "type": "array" }, - "results": { "items": { "type": "string" }, "type": "array" } + "installed": { + "items": { + "type": "string" + }, + "type": "array" + }, + "results": { + "items": { + "type": "string" + }, + "type": "array" + } }, "type": "object" } @@ -119,34 +175,57 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "app_id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "format": "uuid", "type": "string" }, "created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The GMT date the application password was created.", "format": "date-time", "readonly": true, "type": "string" }, "last_ip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The IP address the application password was last used by.", "format": "ip", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "last_used": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The GMT date the application password was last used.", "format": "date-time", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The name of the application password.", "minLength": 1, "pattern": ".*\\S.*", @@ -154,13 +233,19 @@ "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "The generated password. Only available after adding an application.", "readonly": true, "type": "string" }, "uuid": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The unique identifier for the application password.", "format": "uuid", "readonly": true, @@ -176,38 +261,72 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}", "rel": "https:/api.w.org/action-assign-author", - "targetSchema": { "properties": { "author": { "type": "integer" } }, "type": "object" }, + "targetSchema": { + "properties": { + "author": { + "type": "integer" + } + }, + "type": "object" + }, "title": "The current user can change the author on this post." } ], "properties": { "alt_text": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the post.", "type": "integer" }, "caption": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The attachment caption.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Caption for the attachment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML caption for the attachment, transformed for display.", "readonly": true, "type": "string" @@ -216,41 +335,73 @@ "type": "object" }, "class_list": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of the class names for the post container element.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "comment_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attachment description.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Description for the attachment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description for the attachment, transformed for display.", "readonly": true, "type": "string" @@ -259,28 +410,42 @@ "type": "object" }, "featured_media": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the featured media for the post.", "type": "integer" }, "generated_slug": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Slug automatically generated from the post title.", "readonly": true, "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -290,124 +455,200 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "media_details": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Details about the media file, specific to its type.", "readonly": true, "type": "object" }, "media_type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Attachment type.", - "enum": ["image", "file"], + "enum": [ + "file", + "image" + ], "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "mime_type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The attachment MIME type.", "readonly": true, "type": "string" }, "missing_image_sizes": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "List of the missing image sizes of the attachment.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "permalink_template": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Permalink template for the post.", "readonly": true, "type": "string" }, "ping_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "post": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "source_url": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the original attachment file.", "format": "uri", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -416,7 +657,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -429,21 +674,36 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "create": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of created resources.", - "items": { "type": "object" }, + "items": { + "type": "object" + }, "type": "array" }, "delete": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of deleted resources.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "update": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of updated resources.", - "items": { "type": "object" }, + "items": { + "type": "object" + }, "type": "array" } }, @@ -454,52 +714,95 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "active_installs": { - "context": ["view"], + "context": [ + "view" + ], "description": "The number of sites that have activated this block.", "type": "integer" }, "author": { - "context": ["view"], + "context": [ + "view" + ], "description": "The WordPress.org username of the block author.", "type": "string" }, "author_block_count": { - "context": ["view"], + "context": [ + "view" + ], "description": "The number of blocks published by the same author.", "type": "integer" }, "author_block_rating": { - "context": ["view"], + "context": [ + "view" + ], "description": "The average rating of blocks published by the same author.", "type": "number" }, "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "A short description of the block, in human readable format.", "type": "string" }, "humanized_updated": { - "context": ["view"], + "context": [ + "view" + ], "description": "The date when the block was last updated, in fuzzy human readable format.", "type": "string" }, - "icon": { "context": ["view"], "description": "The block icon.", "format": "uri", "type": "string" }, - "id": { "context": ["view"], "description": "The block slug.", "type": "string" }, + "icon": { + "context": [ + "view" + ], + "description": "The block icon.", + "format": "uri", + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "The block slug.", + "type": "string" + }, "last_updated": { - "context": ["view"], + "context": [ + "view" + ], "description": "The date when the block was last updated.", "format": "date-time", "type": "string" }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "The block name, in namespace/block-name format.", "type": "string" }, - "rating": { "context": ["view"], "description": "The star rating of the block.", "type": "number" }, - "rating_count": { "context": ["view"], "description": "The number of ratings.", "type": "integer" }, + "rating": { + "context": [ + "view" + ], + "description": "The star rating of the block.", + "type": "number" + }, + "rating_count": { + "context": [ + "view" + ], + "description": "The number of ratings.", + "type": "integer" + }, "title": { - "context": ["view"], + "context": [ + "view" + ], "description": "The block title, in human readable format.", "type": "string" } @@ -511,81 +814,129 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "block_types": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Block types that the pattern is intended to be used with.", "readonly": true, "type": "array" }, "categories": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern's category slugs.", "readonly": true, "type": "array" }, "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern content.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern detailed description.", "readonly": true, "type": "string" }, "inserter": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Determines whether the pattern is visible in inserter.", "readonly": true, "type": "boolean" }, "keywords": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern keywords.", "readonly": true, "type": "array" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern name.", "readonly": true, "type": "string" }, "post_types": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An array of post types that the pattern is restricted to be used with.", "readonly": true, "type": "array" }, "source": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Where the pattern comes from e.g. core", "enum": [ "core", - "plugin", - "theme", "pattern-directory/core", + "pattern-directory/featured", "pattern-directory/theme", - "pattern-directory/featured" + "plugin", + "theme" ], "readonly": true, "type": "string" }, "template_types": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An array of template types where the pattern fits.", "readonly": true, "type": "array" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern title, in human readable format.", "readonly": true, "type": "string" }, "viewport_width": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern viewport width for inserter preview.", "readonly": true, "type": "number" @@ -598,19 +949,31 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The category description in a human-readable format.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The category label, in human readable format.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The category name.", "readonly": true, "type": "string" @@ -623,44 +986,86 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "allowed_blocks": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Allowed child block types.", - "items": { "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", "type": "string" }, + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "ancestor": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Ancestor blocks.", - "items": { "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", "type": "string" }, + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "api_version": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": 1, "description": "Version of block API.", "readonly": true, "type": "integer" }, "attributes": { - "additionalProperties": { "type": "object" }, - "context": ["embed", "view", "edit"], + "additionalProperties": { + "type": "object" + }, + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block attributes.", "properties": [], "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "block_hooks": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "This block is automatically inserted near any occurrence of the block types used as keys of this map, into a relative position given by the corresponding value.", "patternProperties": { "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$": { - "enum": ["before", "after", "first_child", "last_child"], + "enum": [ + "after", + "before", + "first_child", + "last_child" + ], "type": "string" } }, @@ -668,60 +1073,111 @@ "type": "object" }, "category": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block category.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Description of block type.", "readonly": true, "type": "string" }, "editor_script": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Editor script handle. DEPRECATED: Use `editor_script_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "editor_script_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Editor script handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "editor_style": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Editor style handle. DEPRECATED: Use `editor_style_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "editor_style_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Editor style handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "example": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block example.", "properties": { - "attributes": { "description": "The attributes used in the example.", "type": "object" }, + "attributes": { + "description": "The attributes used in the example.", + "type": "object" + }, "innerBlocks": { "description": "The list of inner blocks used in the example.", "items": { "properties": { - "attributes": { "description": "The attributes of the inner block.", "type": "object" }, + "attributes": { + "description": "The attributes of the inner block.", + "type": "object" + }, "innerBlocks": { "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", "type": "array" @@ -739,32 +1195,56 @@ } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "icon": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Icon of block type.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "is_dynamic": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": false, "description": "Is the block dynamically rendered.", "readonly": true, "type": "boolean" }, "keywords": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Block keywords.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique name identifying the block type.", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", "readonly": true, @@ -772,16 +1252,32 @@ "type": "string" }, "parent": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Parent blocks.", - "items": { "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", "type": "string" }, + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "provides_context": { - "additionalProperties": { "type": "string" }, - "context": ["embed", "view", "edit"], + "additionalProperties": { + "type": "string" + }, + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Context provided by blocks of this type.", "properties": [], @@ -789,22 +1285,41 @@ "type": "object" }, "script": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "script_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public facing and editor script handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "selectors": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Custom CSS selectors.", "properties": [], @@ -812,22 +1327,41 @@ "type": "object" }, "style": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "style_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public facing and editor style handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "styles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Block style variations.", "items": { @@ -836,9 +1370,19 @@ "description": "Inline CSS code that registers the CSS class required for the style.", "type": "string" }, - "label": { "description": "The human-readable label for the style.", "type": "string" }, - "name": { "description": "Unique name identifying the style.", "required": true, "type": "string" }, - "style_handle": { "description": "Contains the handle that defines the block style.", "type": "string" } + "label": { + "description": "The human-readable label for the style.", + "type": "string" + }, + "name": { + "description": "Unique name identifying the style.", + "required": true, + "type": "string" + }, + "style_handle": { + "description": "Contains the handle that defines the block style.", + "type": "string" + } }, "type": "object" }, @@ -846,7 +1390,11 @@ "type": "array" }, "supports": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Block supports.", "properties": [], @@ -854,40 +1402,71 @@ "type": "object" }, "textdomain": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Public text domain.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Title of block type.", "readonly": true, "type": "string" }, "uses_context": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Context values inherited by blocks of this type.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "variations": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block variations.", "items": { "properties": { - "attributes": { "description": "The initial values for attributes.", "type": "object" }, + "attributes": { + "description": "The initial values for attributes.", + "type": "object" + }, "category": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block category.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "description": { "description": "A detailed variation description.", @@ -895,16 +1474,26 @@ "type": "string" }, "example": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Block example.", "properties": { - "attributes": { "description": "The attributes used in the example.", "type": "object" }, + "attributes": { + "description": "The attributes used in the example.", + "type": "object" + }, "innerBlocks": { "description": "The list of inner blocks used in the example.", "items": { "properties": { - "attributes": { "description": "The attributes of the inner block.", "type": "object" }, + "attributes": { + "description": "The attributes of the inner block.", + "type": "object" + }, "innerBlocks": { "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", "type": "array" @@ -922,20 +1511,33 @@ } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "icon": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Icon of block type.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "innerBlocks": { "description": "The list of inner blocks used in the example.", "items": { "properties": { - "attributes": { "description": "The attributes of the inner block.", "type": "object" }, + "attributes": { + "description": "The attributes of the inner block.", + "type": "object" + }, "innerBlocks": { "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", "type": "array" @@ -958,22 +1560,46 @@ "type": "boolean" }, "keywords": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Block keywords.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, - "name": { "description": "The unique and machine-readable name.", "required": true, "type": "string" }, + "name": { + "description": "The unique and machine-readable name.", + "required": true, + "type": "string" + }, "scope": { "default": null, "description": "The list of scopes where the variation is applicable. When not provided, it assumes all available scopes.", - "items": { "enum": ["block", "inserter", "transform"], "type": "string" }, + "items": { + "enum": [ + "block", + "inserter", + "transform" + ], + "type": "string" + }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, - "title": { "description": "A human-readable variation title.", "required": true, "type": "string" } + "title": { + "description": "A human-readable variation title.", + "required": true, + "type": "string" + } }, "type": "object" }, @@ -981,35 +1607,66 @@ "type": "array" }, "view_script": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": null, "description": "Public facing script handle. DEPRECATED: Use `view_script_handles` instead.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "view_script_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public facing script handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "view_script_module_ids": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public-facing script module IDs.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "view_style_handles": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Public-facing style handles.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, - "type": ["array"] + "type": [ + "array" + ] } }, "title": "block-type", @@ -1019,81 +1676,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "billing_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current set billing address for the customer.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "readonly": true, "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "readonly": true, "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "readonly": true, "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "readonly": true, "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "readonly": true, "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "readonly": true, "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "readonly": true, "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "readonly": true, "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "readonly": true, "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "readonly": true, "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "readonly": true, "required": true, @@ -1104,76 +1797,115 @@ "type": "object" }, "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of applied basket coupons.", "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The coupon's unique code.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The discount type for the coupon (eg percentage or fixed amount)", "readonly": true, "type": "string" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount applied by this coupon.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount applied by this coupon.", "readonly": true, "type": "string" @@ -1189,47 +1921,71 @@ "type": "array" }, "cross_sells": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of cross-sells items related to basket items.", "items": { "properties": { "add_to_cart": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Add to basket button parameters.", "properties": { "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Button description.", "readonly": true, "type": "string" }, "maximum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The maximum quantity that can be added to the basket.", "readonly": true, "type": "integer" }, "minimum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The minimum quantity that can be added to the basket.", "readonly": true, "type": "integer" }, "multiple_of": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 1, "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", "readonly": true, "type": "integer" }, "text": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Button text.", "readonly": true, "type": "string" }, "url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Add to basket URL.", "readonly": true, "type": "string" @@ -1239,59 +1995,89 @@ "type": "object" }, "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of attributes (taxonomy terms) assigned to the product. For variable products, these are mapped to variations (see the `variations` field).", "items": { "properties": { "has_variations": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if this attribute is used by product variations.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute name.", "readonly": true, "type": "string" }, "taxonomy": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute taxonomy, or null if the attribute is not taxonomy based.", "readonly": true, "type": "string" }, "terms": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of assigned attribute terms.", "items": { "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If this is a default attribute", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The term ID, or 0 if the attribute is not a global attribute.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The term name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The term slug.", "readonly": true, "type": "string" @@ -1309,36 +2095,54 @@ "type": "array" }, "average_rating": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reviews average rating.", "readonly": true, "type": "string" }, "categories": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of categories, if applicable.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID", "readonly": true, "type": "number" }, "link": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category link", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug", "readonly": true, "type": "string" @@ -1350,68 +2154,109 @@ "type": "array" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product full description in HTML format.", "readonly": true, "type": "string" }, - "extensions": { "context": ["view", "edit"], "properties": [], "readonly": true, "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, "has_options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Does the product have additional options before it can be added to the basket?", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "images": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of images.", "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "readonly": true, "type": "string" }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "readonly": true, "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "readonly": true, "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "readonly": true, "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "readonly": true, @@ -1424,140 +2269,215 @@ "type": "array" }, "is_in_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the product in stock?", "readonly": true, "type": "boolean" }, "is_on_backorder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the product stock backordered? This will also return false if backorder notifications are turned off.", "readonly": true, "type": "boolean" }, "is_purchasable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the product purchasable?", "readonly": true, "type": "boolean" }, "low_stock_remaining": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity left in stock if stock is low, or null if not applicable.", "readonly": true, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, "type": "string" }, "on_sale": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the product on sale?", "readonly": true, "type": "boolean" }, "parent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ID of the parent product, if applicable.", "readonly": true, "type": "integer" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product URL.", "format": "uri", "readonly": true, "type": "string" }, "price_html": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price string formatted as HTML.", "readonly": true, "type": "string" }, "prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price data provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price range, if applicable.", "properties": { "max_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" }, "min_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" @@ -1567,60 +2487,90 @@ "type": "object" }, "review_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of reviews that the product has.", "readonly": true, "type": "integer" }, "short_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product short description in HTML format.", "readonly": true, "type": "string" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product slug.", "readonly": true, "type": "string" }, "sold_individually": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If true, only one item of this product is allowed for purchase in a single order.", "readonly": true, "type": "boolean" }, "tags": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of tags, if applicable.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID", "readonly": true, "type": "number" }, "link": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag link", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug", "readonly": true, "type": "string" @@ -1632,35 +2582,53 @@ "type": "array" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product type.", "readonly": true, "type": "string" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product variation attributes, if applicable.", "readonly": true, "type": "string" }, "variations": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of variation IDs, if applicable.", "items": { "properties": { "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of variation attributes.", "items": { "properties": { "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute name.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The assigned attribute.", "readonly": true, "type": "string" @@ -1672,7 +2640,10 @@ "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", "readonly": true, "type": "integer" @@ -1690,18 +2661,27 @@ "type": "array" }, "errors": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket item errors, for example, items in the basket which are out of stock.", "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Error code", "readonly": true, "type": "string" }, "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Error message", "readonly": true, "type": "string" @@ -1712,73 +2692,124 @@ "readonly": true, "type": "array" }, - "extensions": { "context": ["view", "edit"], "properties": [], "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "type": "object" + }, "fees": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket fees.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the fee within the basket.", "readonly": true, "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Fee name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "readonly": true, + "type": "string" + }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amount for this fee.", "readonly": true, "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax amount for this fee.", "readonly": true, "type": "string" @@ -1794,85 +2825,137 @@ "type": "array" }, "has_calculated_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket meets the criteria for showing shipping costs, and rates have been calculated and included in the totals.", "readonly": true, "type": "boolean" }, "items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket items.", "items": { "properties": { "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if backorders are allowed past stock availability.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "catalog_visibility": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether the product is visible in the catalogue", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product full description in HTML format.", "readonly": true, "type": "string" }, - "extensions": { "context": ["view", "edit"], "properties": [], "readonly": true, "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item product or variation ID.", "readonly": true, "type": "integer" }, "images": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of images.", "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "readonly": true, "type": "string" }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "readonly": true, "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "readonly": true, "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "readonly": true, "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "readonly": true, @@ -1885,24 +2968,36 @@ "type": "array" }, "item_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Metadata related to the item", "items": { "properties": { "display": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Optionally, how the metadata value should be displayed to the user.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the metadata.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Value of the metadata.", "readonly": true, "type": "string" @@ -1914,142 +3009,220 @@ "type": "array" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the item.", "readonly": true, "type": "string" }, "low_stock_remaining": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity left in stock if stock is low, or null if not applicable.", "readonly": true, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, "type": "string" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product URL.", "format": "uri", "readonly": true, "type": "string" }, "prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price data for the product in the current line item, including or excluding taxes based on the \"display prices during basket and checkout\" setting. Provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price range, if applicable.", "properties": { "max_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" }, "min_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "raw_prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", "properties": { "precision": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal precision of the returned prices.", "readonly": true, "type": "integer" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" @@ -2059,36 +3232,54 @@ "type": "object" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of this item.", "readonly": true, "type": "number" }, "quantity_limits": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How the quantity of this item should be controlled, for example, any limits in place.", "properties": { "editable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "If the quantity is editable or fixed.", "readonly": true, "type": "boolean" }, "maximum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The maximum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "minimum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The minimum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "multiple_of": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 1, "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", "readonly": true, @@ -2099,95 +3290,145 @@ "type": "object" }, "short_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product short description in HTML format.", "readonly": true, "type": "string" }, "show_backorder_badge": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the product is on backorder.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock keeping unit, if applicable.", "readonly": true, "type": "string" }, "sold_individually": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If true, only one item of this product is allowed for purchase in a single order.", "readonly": true, "type": "boolean" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "line_subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (the price of the product before coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax.", "readonly": true, "type": "string" }, "line_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (the price of the product after coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax.", "readonly": true, "type": "string" @@ -2197,24 +3438,36 @@ "type": "object" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item type.", "readonly": true, "type": "string" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Chosen attributes (for variations).", "items": { "properties": { "attribute": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute name.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute value.", "readonly": true, "type": "string" @@ -2232,110 +3485,161 @@ "type": "array" }, "items_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of items in the basket.", "readonly": true, "type": "integer" }, "items_weight": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total weight (in grams) of all products in the basket.", "readonly": true, "type": "number" }, "needs_payment": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.", "readonly": true, "type": "boolean" }, "needs_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.", "readonly": true, "type": "boolean" }, "payment_methods": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available payment method IDs that can be used to process the order.", "readonly": true, "type": "array" }, "payment_requirements": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of required payment gateway features to process the order.", "readonly": true, "type": "array" }, "shipping_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current set shipping address for the customer.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "readonly": true, "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "readonly": true, "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "readonly": true, "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "readonly": true, "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "readonly": true, "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "readonly": true, "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "readonly": true, "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "readonly": true, "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "readonly": true, "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "readonly": true, "required": true, @@ -2346,46 +3650,70 @@ "type": "object" }, "shipping_rates": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available shipping rates for the basket.", "items": { "properties": { "destination": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping destination address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First line of the address being shipped to.", "readonly": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Second line of the address being shipped to.", "readonly": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City of the address being shipped to.", "readonly": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code for the country of the address being shipped to.", "readonly": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Zip or Postcode of the address being shipped to.", "readonly": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code, or name, for the state, province, or district of the address being shipped to.", "readonly": true, "type": "string" @@ -2395,24 +3723,36 @@ "type": "object" }, "items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket items the returned shipping rates apply to.", "items": { "properties": { "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the item within the basket.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the item.", "readonly": true, "type": "string" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of the item in the current package.", "readonly": true, "type": "number" @@ -2424,95 +3764,146 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the package.", "readonly": true, "type": "string" }, "package_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID of the package the shipping rates belong to.", "readonly": true, - "type": ["integer", "string"] + "type": [ + "integer", + "string" + ] }, "shipping_rates": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of shipping rates.", "items": { "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "delivery_time": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Delivery time estimate text, e.g. 3-5 business days.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Description of the shipping rate, e.g. Dispatched via Royal Mail.", "readonly": true, "type": "string" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Instance ID of the shipping method that provided the rate.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data attached to the shipping rate.", "items": { "properties": { "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", "readonly": true, "type": "string" @@ -2524,37 +3915,55 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ID of the shipping method that provided the rate.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the shipping rate, e.g. Express shipping.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price of this shipping rate using the smallest unit of the currency.", "readonly": true, "type": "string" }, "rate_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ID of the shipping rate.", "readonly": true, "type": "string" }, "selected": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if this is the rate currently selected by the customer for the basket.", "readonly": true, "type": "boolean" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxes applied to this shipping rate using the smallest unit of the currency.", "readonly": true, "type": "string" @@ -2572,70 +3981,106 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Basket total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "tax_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Lines of taxes applied to items and shipping.", "items": { "properties": { "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The name of the tax.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The amount of tax charged.", "readonly": true, "type": "string" }, "rate": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The rate at which tax is applied.", "readonly": true, "type": "string" @@ -2647,61 +4092,97 @@ "type": "array" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount from applied coupons.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount from applied coupons.", "readonly": true, "type": "string" }, "total_fees": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of any applied fees.", "readonly": true, "type": "string" }, "total_fees_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on fees.", "readonly": true, "type": "string" }, "total_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of items in the basket.", "readonly": true, "type": "string" }, "total_items_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on items in the basket.", "readonly": true, "type": "string" }, "total_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price the customer will pay.", "readonly": true, "type": "string" }, "total_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of shipping. If shipping has not been calculated, a null response will be sent.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "total_shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax applied to items and shipping.", "readonly": true, "type": "string" @@ -2723,66 +4204,106 @@ "cart_coupon": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "code": { "context": ["view", "edit"], "description": "The coupon's unique code.", "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "The coupon's unique code.", + "type": "string" + }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The discount type for the coupon (eg percentage or fixed amount)", "type": "string" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount applied by this coupon.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount applied by this coupon.", "readonly": true, "type": "string" @@ -2799,56 +4320,113 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if backorders are allowed past stock availability.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "catalog_visibility": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether the product is visible in the catalogue", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product full description in HTML format.", "readonly": true, "type": "string" }, - "extensions": { "context": ["view", "edit"], "properties": [], "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "type": "object" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item product or variation ID.", "readonly": true, "type": "integer" }, "images": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of images.", "items": { "properties": { - "alt": { "context": ["view", "edit"], "description": "Image alternative text.", "type": "string" }, - "id": { "context": ["view", "edit"], "description": "Image ID.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Image name.", "type": "string" }, + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "type": "string" @@ -2860,24 +4438,36 @@ "type": "array" }, "item_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Metadata related to the item", "items": { "properties": { "display": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Optionally, how the metadata value should be displayed to the user.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the metadata.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Value of the metadata.", "readonly": true, "type": "string" @@ -2889,137 +4479,220 @@ "type": "array" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the item.", "readonly": true, "type": "string" }, "low_stock_remaining": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity left in stock if stock is low, or null if not applicable.", "readonly": true, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "readonly": true, "type": "string" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product URL.", "format": "uri", "readonly": true, "type": "string" }, "prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price data for the product in the current line item, including or excluding taxes based on the \"display prices during basket and checkout\" setting. Provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price range, if applicable.", "properties": { "max_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" }, "min_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "raw_prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", "properties": { "precision": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal precision of the returned prices.", "readonly": true, "type": "integer" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" @@ -3029,36 +4702,54 @@ "type": "object" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of this item.", "readonly": true, "type": "number" }, "quantity_limits": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How the quantity of this item should be controlled, for example, any limits in place.", "properties": { "editable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "If the quantity is editable or fixed.", "readonly": true, "type": "boolean" }, "maximum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The maximum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "minimum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The minimum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "multiple_of": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 1, "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", "readonly": true, @@ -3069,95 +4760,145 @@ "type": "object" }, "short_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product short description in HTML format.", "readonly": true, "type": "string" }, "show_backorder_badge": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the product is on backorder.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock keeping unit, if applicable.", "readonly": true, "type": "string" }, "sold_individually": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If true, only one item of this product is allowed for purchase in a single order.", "readonly": true, "type": "boolean" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "line_subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (the price of the product before coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax.", "readonly": true, "type": "string" }, "line_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (the price of the product after coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax.", "readonly": true, "type": "string" @@ -3166,20 +4907,37 @@ "readonly": true, "type": "object" }, - "type": { "context": ["view", "edit"], "description": "The item type.", "readonly": true, "type": "string" }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The item type.", + "readonly": true, + "type": "string" + }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Chosen attributes (for variations).", "items": { "properties": { "attribute": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute name.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute value.", "readonly": true, "type": "string" @@ -3198,46 +4956,89 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, - "parent": { "context": ["view", "edit"], "description": "The parent term ID.", "type": "integer" }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The parent term ID.", + "type": "integer" + }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["category"], + "enum": [ + "category" + ], "readonly": true, "type": "string" } @@ -3249,58 +5050,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "additional_fields": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional fields to be persisted on the order.", "properties": [], "required": false, "type": "object" }, "billing_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City", "required": true, "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company", "required": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "required": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, - "email": { "context": ["view", "edit"], "description": "Email", "required": true, "type": "string" }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone", "required": true, "type": "string" }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -3310,146 +5170,238 @@ "type": "object" }, "create_account": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether to create a new user account as part of order processing.", "type": "boolean" }, "customer_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Customer ID if registered. Will return 0 for guests.", "readonly": true, "type": "integer" }, "customer_note": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Note added to the order by the customer during checkout.", "type": "string" }, "extensions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "properties": { "woocommerce/order-attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] } }, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] } }, "type": "object" }, "order_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The order ID to process during checkout.", "readonly": true, "type": "integer" }, "order_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order key used to check validity or protect access to certain order data.", "readonly": true, "type": "string" }, "order_number": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order number used for display.", "readonly": true, "type": "string" }, "payment_method": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID of the payment method being used to process the payment.", - "enum": ["bacs", "cheque", "cod"], + "enum": [ + "bacs", + "cheque", + "cod" + ], "type": "string" }, "payment_result": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Result of payment processing, or false if not yet processed.", "properties": { "payment_details": { "description": "An array of data being returned from the payment gateway.", "items": { - "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, "type": "object" }, "readonly": true, @@ -3470,50 +5422,98 @@ "type": "object" }, "shipping_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City", "required": true, "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company", "required": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "required": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone", "required": true, "type": "string" }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -3522,7 +5522,10 @@ "type": "object" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order status. Payment providers will update this value after payment.", "readonly": true, "type": "string" @@ -3535,58 +5538,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "additional_fields": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional fields to be persisted on the order.", "properties": [], "required": false, "type": "object" }, "billing_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City", "required": true, "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company", "required": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "required": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, - "email": { "context": ["view", "edit"], "description": "Email", "required": true, "type": "string" }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone", "required": true, "type": "string" }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -3596,141 +5658,230 @@ "type": "object" }, "customer_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Customer ID if registered. Will return 0 for guests.", "readonly": true, "type": "integer" }, "customer_note": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Note added to the order by the customer during checkout.", "type": "string" }, "extensions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "properties": { "woocommerce/order-attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] } }, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] } }, "type": "object" }, "order_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The order ID to process during checkout.", "readonly": true, "type": "integer" }, "order_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order key used to check validity or protect access to certain order data.", "readonly": true, "type": "string" }, "order_number": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order number used for display.", "readonly": true, "type": "string" }, "payment_method": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID of the payment method being used to process the payment.", - "enum": ["bacs", "cheque", "cod"], + "enum": [ + "bacs", + "cheque", + "cod" + ], "type": "string" }, "payment_result": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Result of payment processing, or false if not yet processed.", "properties": { "payment_details": { "description": "An array of data being returned from the payment gateway.", "items": { - "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, "type": "object" }, "readonly": true, @@ -3751,50 +5902,98 @@ "type": "object" }, "shipping_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City", "required": true, "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company", "required": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "required": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone", "required": true, "type": "string" }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -3803,7 +6002,10 @@ "type": "object" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order status. Payment providers will update this value after payment.", "readonly": true, "type": "string" @@ -3816,28 +6018,48 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the user object, if author was a user.", "type": "integer" }, "author_avatar_urls": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URLs for the comment author.", "properties": { "24": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 24 pixels.", "format": "uri", "type": "string" }, "48": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 48 pixels.", "format": "uri", "type": "string" }, "96": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 96 pixels.", "format": "uri", "type": "string" @@ -3847,44 +6069,68 @@ "type": "object" }, "author_email": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Email address for the comment author.", "format": "email", "type": "string" }, "author_ip": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "IP address for the comment author.", "format": "ip", "type": "string" }, "author_name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Display name for the comment author.", "type": "string" }, "author_url": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL for the comment author.", "format": "uri", "type": "string" }, "author_user_agent": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "User agent for the comment author.", "type": "string" }, "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The content for the comment.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the comment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the comment, transformed for display.", "readonly": true, "type": "string" @@ -3893,46 +6139,87 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the comment was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the comment was published, as GMT.", "format": "date-time", "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the comment.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the comment.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 0, "description": "The ID for the parent of the comment.", "type": "integer" }, "post": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 0, "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "context": ["view", "edit"], "description": "State of the comment.", "type": "string" }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "State of the comment.", + "type": "string" + }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of the comment.", "readonly": true, "type": "string" @@ -3945,32 +6232,107 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "avatar_url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Avatar URL.", "readonly": true, "type": "string" }, "billing": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of billing address data.", "properties": { - "address_1": { "context": ["view", "edit"], "description": "Address line 1", "type": "string" }, - "address_2": { "context": ["view", "edit"], "description": "Address line 2", "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company name.", "type": "string" }, - "country": { "context": ["view", "edit"], "description": "ISO code of the country.", "type": "string" }, + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "ISO code of the country.", + "type": "string" + }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "First name.", "type": "string" }, - "last_name": { "context": ["view", "edit"], "description": "Last name.", "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone number.", "type": "string" }, - "postcode": { "context": ["view", "edit"], "description": "Postal code.", "type": "string" }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name.", + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name.", + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone number.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" + }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -3978,84 +6340,223 @@ "type": "object" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the customer was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the customer was created, as GMT.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the customer was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the customer was last modified, as GMT.", "readonly": true, "type": "date-time" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The email address for the customer.", "format": "email", "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "Customer first name.", "type": "string" }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "Customer first name.", + "type": "string" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "is_paying_customer": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Is the customer a paying customer?", "readonly": true, "type": "bool" }, - "last_name": { "context": ["view", "edit"], "description": "Customer last name.", "type": "string" }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Customer last name.", + "type": "string" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of orders made by the customer.", "readonly": true, "type": "integer" }, - "password": { "context": ["edit"], "description": "Customer password.", "type": "string" }, - "role": { "context": ["view", "edit"], "description": "Customer role.", "readonly": true, "type": "string" }, + "password": { + "context": [ + "edit" + ], + "description": "Customer password.", + "type": "string" + }, + "role": { + "context": [ + "edit", + "view" + ], + "description": "Customer role.", + "readonly": true, + "type": "string" + }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of shipping address data.", "properties": { - "address_1": { "context": ["view", "edit"], "description": "Address line 1", "type": "string" }, - "address_2": { "context": ["view", "edit"], "description": "Address line 2", "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company name.", "type": "string" }, - "country": { "context": ["view", "edit"], "description": "ISO code of the country.", "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "First name.", "type": "string" }, - "last_name": { "context": ["view", "edit"], "description": "Last name.", "type": "string" }, - "postcode": { "context": ["view", "edit"], "description": "Postal code.", "type": "string" }, + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "ISO code of the country.", + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name.", + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" + }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -4063,12 +6564,22 @@ "type": "object" }, "total_spent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amount spent.", "readonly": true, "type": "string" }, - "username": { "context": ["view", "edit"], "description": "Customer login name.", "type": "string" } + "username": { + "context": [ + "edit", + "view" + ], + "description": "Customer login name.", + "type": "string" + } }, "title": "customer", "type": "object" @@ -4077,55 +6588,111 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "access_expires": { - "context": ["view"], + "context": [ + "view" + ], "description": "The date when download access expires, in the site's timezone.", "readonly": true, "type": "string" }, "access_expires_gmt": { - "context": ["view"], + "context": [ + "view" + ], "description": "The date when download access expires, as GMT.", "readonly": true, "type": "string" }, - "download_id": { "context": ["view"], "description": "Download ID.", "readonly": true, "type": "string" }, + "download_id": { + "context": [ + "view" + ], + "description": "Download ID.", + "readonly": true, + "type": "string" + }, "download_name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Downloadable file name.", "readonly": true, "type": "string" }, "download_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Download file URL.", "readonly": true, "type": "string" }, "downloads_remaining": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of downloads remaining.", "readonly": true, "type": "string" }, "file": { - "context": ["view"], + "context": [ + "view" + ], "description": "File details.", "properties": { - "file": { "context": ["view"], "description": "File URL.", "readonly": true, "type": "string" }, - "name": { "context": ["view"], "description": "File name.", "readonly": true, "type": "string" } + "file": { + "context": [ + "view" + ], + "description": "File URL.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "File name.", + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" }, - "order_id": { "context": ["view"], "description": "Order ID.", "readonly": true, "type": "integer" }, - "order_key": { "context": ["view"], "description": "Order key.", "readonly": true, "type": "string" }, + "order_id": { + "context": [ + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, + "order_key": { + "context": [ + "view" + ], + "description": "Order key.", + "readonly": true, + "type": "string" + }, "product_id": { - "context": ["view"], + "context": [ + "view" + ], "description": "Downloadable product ID.", "readonly": true, "type": "integer" }, - "product_name": { "context": ["view"], "description": "Product name.", "readonly": true, "type": "string" } + "product_name": { + "context": [ + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + } }, "title": "customer_download", "type": "object" @@ -4134,68 +6701,101 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "code": { - "context": ["view"], + "context": [ + "view" + ], "description": "2 character continent code.", "readonly": true, "type": "string" }, "countries": { - "context": ["view"], + "context": [ + "view" + ], "description": "List of countries on this continent.", "items": { - "context": ["view"], + "context": [ + "view" + ], "properties": { "code": { - "context": ["view"], + "context": [ + "view" + ], "description": "ISO3166 alpha-2 country code.", "readonly": true, "type": "string" }, "currency_code": { - "context": ["view"], + "context": [ + "view" + ], "description": "Default ISO4127 alpha-3 currency code for the country.", "readonly": true, "type": "string" }, "currency_pos": { - "context": ["view"], + "context": [ + "view" + ], "description": "Currency symbol position for this country.", "readonly": true, "type": "string" }, "decimal_sep": { - "context": ["view"], + "context": [ + "view" + ], "description": "Decimal separator for displayed prices for this country.", "readonly": true, "type": "string" }, "dimension_unit": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unit lengths are defined in for this country.", "readonly": true, "type": "string" }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Full name of country.", "readonly": true, "type": "string" }, "num_decimals": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of decimal points shown in displayed prices for this country.", "readonly": true, "type": "integer" }, "states": { - "context": ["view"], + "context": [ + "view" + ], "description": "List of states in this country.", "items": { - "context": ["view"], + "context": [ + "view" + ], "properties": { - "code": { "context": ["view"], "description": "State code.", "readonly": true, "type": "string" }, + "code": { + "context": [ + "view" + ], + "description": "State code.", + "readonly": true, + "type": "string" + }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Full name of state.", "readonly": true, "type": "string" @@ -4208,13 +6808,17 @@ "type": "array" }, "thousand_sep": { - "context": ["view"], + "context": [ + "view" + ], "description": "Thousands separator for displayed prices in this country.", "readonly": true, "type": "string" }, "weight_unit": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unit weights are defined in for this country.", "readonly": true, "type": "string" @@ -4226,7 +6830,14 @@ "readonly": true, "type": "array" }, - "name": { "context": ["view"], "description": "Full name of continent.", "readonly": true, "type": "string" } + "name": { + "context": [ + "view" + ], + "description": "Full name of continent.", + "readonly": true, + "type": "string" + } }, "title": "data_continents", "type": "object" @@ -4235,21 +6846,43 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "code": { - "context": ["view"], + "context": [ + "view" + ], "description": "ISO3166 alpha-2 country code.", "readonly": true, "type": "string" }, - "name": { "context": ["view"], "description": "Full name of country.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Full name of country.", + "readonly": true, + "type": "string" + }, "states": { - "context": ["view"], + "context": [ + "view" + ], "description": "List of states in this country.", "items": { - "context": ["view"], + "context": [ + "view" + ], "properties": { - "code": { "context": ["view"], "description": "State code.", "readonly": true, "type": "string" }, + "code": { + "context": [ + "view" + ], + "description": "State code.", + "readonly": true, + "type": "string" + }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Full name of state.", "readonly": true, "type": "string" @@ -4268,9 +6901,30 @@ "data_currencies": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "code": { "context": ["view"], "description": "ISO4217 currency code.", "readonly": true, "type": "string" }, - "name": { "context": ["view"], "description": "Full name of currency.", "readonly": true, "type": "string" }, - "symbol": { "context": ["view"], "description": "Currency symbol.", "readonly": true, "type": "string" } + "code": { + "context": [ + "view" + ], + "description": "ISO4217 currency code.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of currency.", + "readonly": true, + "type": "string" + }, + "symbol": { + "context": [ + "view" + ], + "description": "Currency symbol.", + "readonly": true, + "type": "string" + } }, "title": "data_currencies", "type": "object" @@ -4278,7 +6932,14 @@ "data_download_ips": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "user_ip_address": { "context": ["view"], "description": "IP address.", "readonly": true, "type": "string" } + "user_ip_address": { + "context": [ + "view" + ], + "description": "IP address.", + "readonly": true, + "type": "string" + } }, "title": "data_download_ips", "type": "object" @@ -4287,12 +6948,21 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "Data resource description.", "readonly": true, "type": "string" }, - "slug": { "context": ["view"], "description": "Data resource ID.", "readonly": true, "type": "string" } + "slug": { + "context": [ + "view" + ], + "description": "Data resource ID.", + "readonly": true, + "type": "string" + } }, "title": "data_index", "type": "object" @@ -4301,27 +6971,47 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "categories": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The categories for the font collection.", "type": "array" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The description for the font collection.", "type": "string" }, "font_families": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The font families for the font collection.", "type": "array" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The name for the font collection.", "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the font collection.", "readonly": true, "type": "string" @@ -4334,12 +7024,17 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "headers": { - "context": ["view"], + "context": [ + "view" + ], "description": "Table headers.", "items": { "properties": { "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Table column header.", "readonly": true, "type": "string" @@ -4350,34 +7045,56 @@ "readonly": true, "type": "array" }, - "id": { "context": ["view"], "description": "Leaderboard ID.", "readonly": true, "type": "string" }, + "id": { + "context": [ + "view" + ], + "description": "Leaderboard ID.", + "readonly": true, + "type": "string" + }, "label": { - "context": ["view"], + "context": [ + "view" + ], "description": "Displayed title for the leaderboard.", "readonly": true, "type": "string" }, "rows": { - "context": ["view"], + "context": [ + "view" + ], "description": "Table rows.", "items": { "properties": { "display": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Table cell display.", "readonly": true, "type": "string" }, "format": { - "context": ["view"], + "context": [ + "view" + ], "description": "Table cell format.", - "enum": ["currency", "number"], + "enum": [ + "currency", + "number" + ], "readonly": true, "required": false, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Table cell value.", "readonly": true, "type": "string" @@ -4396,45 +7113,81 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "channel": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unique identifier for the marketing channel that this campaign belongs to.", "readonly": true, "type": "string" }, "cost": { - "context": ["view"], + "context": [ + "view" + ], "description": "Cost of the marketing campaign.", "properties": { - "currency": { "context": ["view"], "readonly": true, "type": "string" }, - "value": { "context": ["view"], "readonly": true, "type": "string" } + "currency": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" }, "id": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unique identifier for the marketing campaign.", "readonly": true, "type": "string" }, "manage_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "URL to the campaign management page.", "readonly": true, "type": "string" }, "sales": { - "context": ["view"], + "context": [ + "view" + ], "description": "Sales of the marketing campaign.", "properties": { - "currency": { "context": ["view"], "readonly": true, "type": "string" }, - "value": { "context": ["view"], "readonly": true, "type": "string" } + "currency": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" }, "title": { - "context": ["view"], + "context": [ + "view" + ], "description": "Title of the marketing campaign.", "readonly": true, "type": "string" @@ -4447,17 +7200,23 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "channel": { - "context": ["view"], + "context": [ + "view" + ], "description": "The marketing channel that this campaign type belongs to.", "properties": { "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "The name of the marketing channel that this campaign type belongs to.", "readonly": true, "type": "string" }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unique identifier of the marketing channel that this campaign type belongs to.", "readonly": true, "type": "string" @@ -4467,31 +7226,41 @@ "type": "object" }, "create_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "URL to the create campaign page for this campaign type.", "readonly": true, "type": "string" }, "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "Description of the marketing campaign type.", "readonly": true, "type": "string" }, "icon_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "URL to an image/icon for the campaign type.", "readonly": true, "type": "string" }, "id": { - "context": ["view"], + "context": [ + "view" + ], "description": "The unique identifier for the marketing campaign type.", "readonly": true, "type": "string" }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Name of the marketing campaign type.", "readonly": true, "type": "string" @@ -4504,49 +7273,65 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "Description of the marketing channel.", "readonly": true, "type": "string" }, "errors_count": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).", "readonly": true, "type": "string" }, "icon": { - "context": ["view"], + "context": [ + "view" + ], "description": "Path to the channel icon.", "readonly": true, "type": "string" }, "is_setup_completed": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not the marketing channel is set up.", "readonly": true, "type": "boolean" }, "name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Name of the marketing channel.", "readonly": true, "type": "string" }, "product_listings_status": { - "context": ["view"], + "context": [ + "view" + ], "description": "Status of the marketing channel's product listings.", "readonly": true, "type": "string" }, "settings_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "URL to the settings page, or the link to complete the setup/onboarding if the channel has not been set up yet.", "readonly": true, "type": "string" }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "Unique identifier string for the marketing channel extension, also known as the plugin slug.", "readonly": true, "type": "string" @@ -4558,19 +7343,74 @@ "marketing_recommendation": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "categories": { "context": ["view"], "items": { "type": "string" }, "readonly": true, "type": "array" }, - "description": { "context": ["view"], "readonly": true, "type": "string" }, - "direct_install": { "context": ["view"], "readonly": true, "type": "string" }, - "icon": { "context": ["view"], "readonly": true, "type": "string" }, - "plugin": { "context": ["view"], "readonly": true, "type": "string" }, - "product": { "context": ["view"], "readonly": true, "type": "string" }, - "subcategories": { - "context": ["view"], + "categories": { + "context": [ + "view" + ], "items": { - "context": ["view"], + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "description": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "direct_install": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "icon": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "plugin": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "product": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "subcategories": { + "context": [ + "view" + ], + "items": { + "context": [ + "view" + ], "properties": { - "name": { "context": ["view"], "readonly": true, "type": "string" }, - "slug": { "context": ["view"], "readonly": true, "type": "string" } + "name": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" @@ -4579,12 +7419,28 @@ "type": "array" }, "tags": { - "context": ["view"], + "context": [ + "view" + ], "items": { - "context": ["view"], + "context": [ + "view" + ], "properties": { - "name": { "context": ["view"], "readonly": true, "type": "string" }, - "slug": { "context": ["view"], "readonly": true, "type": "string" } + "name": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" @@ -4592,8 +7448,20 @@ "readonly": true, "type": "array" }, - "title": { "context": ["view"], "readonly": true, "type": "string" }, - "url": { "context": ["view"], "readonly": true, "type": "string" } + "title": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } }, "title": "marketing_recommendation", "type": "object" @@ -4602,19 +7470,31 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The description of the menu location.", "readonly": true, "type": "string" }, "menu": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the assigned menu.", "readonly": true, "type": "integer" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The name of the menu location.", "readonly": true, "type": "string" @@ -4627,36 +7507,67 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "auto_add": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "locations": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The locations assigned to the menu.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } @@ -4671,7 +7582,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -4679,14 +7598,30 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/action-assign-menus", "targetSchema": { - "properties": { "menus": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "menus": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the nav_menu taxonomy." @@ -4695,7 +7630,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/action-create-menus", "targetSchema": { - "properties": { "menus": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "menus": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the nav_menu taxonomy." @@ -4703,29 +7645,54 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", "rel": "https:/api.w.org/menu-item-object", - "targetSchema": { "properties": { "object": { "type": "integer" } }, "type": "object" }, + "targetSchema": { + "properties": { + "object": { + "type": "integer" + } + }, + "type": "object" + }, "title": "Get linked object." } ], "properties": { "attr_title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, "classes": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Class names for the link element of this menu item.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The description of this menu item.", "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 0, "description": "Unique identifier for the object.", "minimum": 0, @@ -4733,111 +7700,189 @@ "type": "integer" }, "invalid": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the menu item represents an object that no longer exists .", "readonly": true, "type": "boolean" }, "menu_order": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 1, "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "minimum": 1, "type": "integer" }, "menus": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "object": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" }, "object_id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 0, "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "minimum": 0, "type": "integer" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 0, "description": "The ID for the parent of the object.", "minimum": 0, "type": "integer" }, "status": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": "publish", "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "target": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The target attribute of the link element for this menu item.", - "enum": ["_blank", ""], + "enum": [ + "", + "_blank" + ], "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the object.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["string", "object"] + "type": [ + "object", + "string" + ] }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": "custom", "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "enum": ["taxonomy", "post_type", "post_type_archive", "custom"], + "enum": [ + "custom", + "post_type", + "post_type_archive", + "taxonomy" + ], "type": "string" }, "type_label": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The singular label used to describe this type of menu item.", "readonly": true, "type": "string" }, "url": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The URL to which this menu item points.", "format": "uri", "type": "string" }, "xfn": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The XFN relationship expressed in the link of this menu item.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" } }, @@ -4848,79 +7893,134 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the revision, as it exists in the database.", "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the object.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["string", "object"] + "type": [ + "object", + "string" + ] } }, "title": "nav_menu_item-revision", @@ -4930,7 +8030,11 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The unique identifier for the Navigation Menu.", "readonly": true, "type": "integer" @@ -4943,109 +8047,170 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "actions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of actions, if any, for the note.", "readonly": true, "type": "array" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content of the note.", "readonly": true, "type": "string" }, "content_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content data for the note. JSON string. Available for re-localisation.", "readonly": true, "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date the note was created.", "readonly": true, "type": "string" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date the note was created (GMT).", "readonly": true, "type": "string" }, "date_reminder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date after which the user should be reminded of the note, if any.", "readonly": true, "type": "string" }, "date_reminder_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date after which the user should be reminded of the note, if any (GMT).", "readonly": true, "type": "string" }, - "id": { "context": ["view"], "description": "ID of the note record.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "view" + ], + "description": "ID of the note record.", + "readonly": true, + "type": "integer" + }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The image of the note, if any.", "readonly": true, "type": "string" }, "is_deleted": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Registers whether the note is deleted or not", "readonly": true, "type": "boolean" }, "is_read": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Registers whether the note is read or not", "readonly": true, "type": "boolean" }, "is_snoozable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not a user can request to be reminded about the note.", "readonly": true, "type": "boolean" }, "layout": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The layout of the note (eg banner, thumbnail, plain).", "readonly": true, "type": "string" }, "locale": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Locale used for the note title and content.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the note.", "readonly": true, "type": "string" }, "source": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Source of the note.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The status of the note (e.g. unactioned, actioned).", "type": "string" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Title of the note.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The type of the note (eg error, warning, etc).", "readonly": true, "type": "string" @@ -5058,112 +8223,187 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "business_extensions": { - "context": ["view"], + "context": [ + "view" + ], "description": "Extra business extensions to install.", "readonly": true, "type": "array" }, "completed": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not the profile was completed.", "readonly": true, "type": "boolean" }, - "industry": { "context": ["view"], "description": "Industry.", "readonly": true, "type": "array" }, + "industry": { + "context": [ + "view" + ], + "description": "Industry.", + "readonly": true, + "type": "array" + }, "is_agree_marketing": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "readonly": true, "type": "boolean" }, "is_plugins_page_skipped": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not plugins step in core profiler was skipped.", "readonly": true, "type": "boolean" }, "is_store_country_set": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not this store country is set via onboarding profiler.", "readonly": true, "type": "boolean" }, "number_employees": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of employees of the store.", - "enum": ["1", "<10", "10-50", "50-250", "+250", "not specified"], + "enum": [ + "+250", + "<10", + "1", + "10-50", + "50-250", + "not specified" + ], "readonly": true, "type": "string" }, "other_platform": { - "context": ["view"], + "context": [ + "view" + ], "description": "Name of other platform used to sell.", - "enum": ["shopify", "bigcommerce", "magento", "wix", "amazon", "ebay", "etsy", "squarespace", "other"], + "enum": [ + "amazon", + "bigcommerce", + "ebay", + "etsy", + "magento", + "other", + "shopify", + "squarespace", + "wix" + ], "readonly": true, "type": "string" }, "other_platform_name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Name of other platform used to sell (not listed).", "readonly": true, "type": "string" }, "product_count": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of products to be added.", - "enum": ["0", "1-10", "11-100", "101-1000", "1000+"], + "enum": [ + "0", + "1-10", + "1000+", + "101-1000", + "11-100" + ], "readonly": true, "type": "string" }, "product_types": { - "context": ["view"], + "context": [ + "view" + ], "description": "Types of products sold.", "readonly": true, "type": "array" }, "revenue": { - "context": ["view"], + "context": [ + "view" + ], "description": "Current annual revenue of the store.", "enum": [ - "none", - "up-to-2500", - "2500-10000", "10000-50000", + "2500-10000", "50000-250000", "more-than-250000", - "rather-not-say" + "none", + "rather-not-say", + "up-to-2500" ], "readonly": true, "type": "string" }, "selling_venues": { - "context": ["view"], + "context": [ + "view" + ], "description": "Other places the store is selling products.", - "enum": ["no", "other", "brick-mortar", "brick-mortar-other", "other-woocommerce"], + "enum": [ + "brick-mortar", + "brick-mortar-other", + "no", + "other", + "other-woocommerce" + ], "readonly": true, "type": "string" }, "setup_client": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not this store was setup for a client.", "readonly": true, "type": "boolean" }, "skipped": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not the profile was skipped.", "readonly": true, "type": "boolean" }, "store_email": { - "context": ["view"], + "context": [ + "view" + ], "description": "Store email address.", "readonly": true, "type": "string" }, - "theme": { "context": ["view"], "description": "Selected store theme.", "readonly": true, "type": "string" }, + "theme": { + "context": [ + "view" + ], + "description": "Selected store theme.", + "readonly": true, + "type": "string" + }, "wccom_connected": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", "readonly": true, "type": "boolean" @@ -5175,9 +8415,33 @@ "onboarding_theme": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view", "edit"], "description": "Theme name.", "readonly": true, "type": "string" }, - "slug": { "context": ["view", "edit"], "description": "Theme slug.", "readonly": true, "type": "string" }, - "status": { "context": ["view", "edit"], "description": "Theme status.", "readonly": true, "type": "string" } + "name": { + "context": [ + "edit", + "view" + ], + "description": "Theme name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Theme slug.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Theme status.", + "readonly": true, + "type": "string" + } }, "title": "onboarding_theme", "type": "object" @@ -5186,7 +8450,9 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "options": { - "context": ["view"], + "context": [ + "view" + ], "description": "Array of options with associated values.", "readonly": true, "type": "array" @@ -5199,81 +8465,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "billing_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current set billing address for the customer.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "readonly": true, "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "readonly": true, "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "readonly": true, "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "readonly": true, "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "readonly": true, "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "readonly": true, "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "readonly": true, "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "readonly": true, "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "readonly": true, "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "readonly": true, "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "readonly": true, "required": true, @@ -5284,76 +8586,115 @@ "type": "object" }, "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of applied basket coupons.", "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The coupon's unique code.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The discount type for the coupon (eg percentage or fixed amount)", "readonly": true, "type": "string" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount applied by this coupon.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount applied by this coupon.", "readonly": true, "type": "string" @@ -5369,18 +8710,27 @@ "type": "array" }, "errors": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of basket item errors, for example, items in the basket which are out of stock.", "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Error code", "readonly": true, "type": "string" }, "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Error message", "readonly": true, "type": "string" @@ -5391,81 +8741,138 @@ "readonly": true, "type": "array" }, - "id": { "context": ["view", "edit"], "description": "The order ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The order ID.", + "readonly": true, + "type": "integer" + }, "items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line items data.", "items": { "properties": { "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if backorders are allowed past stock availability.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "catalog_visibility": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether the product is visible in the catalogue", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product full description in HTML format.", "readonly": true, "type": "string" }, - "extensions": { "context": ["view", "edit"], "properties": [], "readonly": true, "type": "object" }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item product or variation ID.", "readonly": true, "type": "integer" }, "images": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of images.", "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "readonly": true, "type": "string" }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "readonly": true, "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "readonly": true, "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "readonly": true, "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "readonly": true, @@ -5478,24 +8885,36 @@ "type": "array" }, "item_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Metadata related to the item", "items": { "properties": { "display": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Optionally, how the metadata value should be displayed to the user.", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Name of the metadata.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Value of the metadata.", "readonly": true, "type": "string" @@ -5507,142 +8926,220 @@ "type": "array" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the item.", "readonly": true, "type": "string" }, "low_stock_remaining": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity left in stock if stock is low, or null if not applicable.", "readonly": true, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, "type": "string" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product URL.", "format": "uri", "readonly": true, "type": "string" }, "prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price data for the product in the current line item, including or excluding taxes based on the \"display prices during basket and checkout\" setting. Provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price range, if applicable.", "properties": { "max_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" }, "min_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price amount.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "raw_prices": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", "properties": { "precision": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal precision of the returned prices.", "readonly": true, "type": "integer" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current product price.", "readonly": true, "type": "string" }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regular product price.", "readonly": true, "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sale product price, if applicable.", "readonly": true, "type": "string" @@ -5652,36 +9149,54 @@ "type": "object" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity of this item.", "readonly": true, "type": "number" }, "quantity_limits": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How the quantity of this item should be controlled, for example, any limits in place.", "properties": { "editable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "If the quantity is editable or fixed.", "readonly": true, "type": "boolean" }, "maximum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The maximum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "minimum": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The minimum quantity allowed for this line item.", "readonly": true, "type": "integer" }, "multiple_of": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 1, "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", "readonly": true, @@ -5692,95 +9207,145 @@ "type": "object" }, "short_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product short description in HTML format.", "readonly": true, "type": "string" }, "show_backorder_badge": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the product is on backorder.", "readonly": true, - "type": ["boolean"] + "type": [ + "boolean" + ] }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock keeping unit, if applicable.", "readonly": true, "type": "string" }, "sold_individually": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If true, only one item of this product is allowed for purchase in a single order.", "readonly": true, "type": "boolean" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item total amounts provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "line_subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (the price of the product before coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax.", "readonly": true, "type": "string" }, "line_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (the price of the product after coupon discounts have been applied).", "readonly": true, "type": "string" }, "line_total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax.", "readonly": true, "type": "string" @@ -5790,24 +9355,36 @@ "type": "object" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The item type.", "readonly": true, "type": "string" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Chosen attributes (for variations).", "items": { "properties": { "attribute": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute name.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute value.", "readonly": true, "type": "string" @@ -5824,92 +9401,134 @@ "type": "array" }, "needs_payment": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.", "readonly": true, "type": "boolean" }, "needs_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.", "readonly": true, "type": "boolean" }, "payment_requirements": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of required payment gateway features to process the order.", "readonly": true, "type": "array" }, "shipping_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current set shipping address for the customer.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "readonly": true, "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "readonly": true, "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "readonly": true, "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "readonly": true, "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "readonly": true, "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "readonly": true, "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "readonly": true, "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "readonly": true, "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "readonly": true, "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "readonly": true, "required": true, @@ -5920,82 +9539,124 @@ "type": "object" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Status of the order.", "readonly": true, "type": "string" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order totals.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Subtotal of the order.", "readonly": true, "type": "string" }, "tax_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Lines of taxes applied to items and shipping.", "items": { "properties": { "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The name of the tax.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The amount of tax charged.", "readonly": true, "type": "string" }, "rate": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The rate at which tax is applied.", "readonly": true, "type": "string" @@ -6007,67 +9668,106 @@ "type": "array" }, "total_discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount from applied coupons.", "readonly": true, "type": "string" }, "total_discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax removed due to discount from applied coupons.", "readonly": true, "type": "string" }, "total_fees": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of any applied fees.", "readonly": true, "type": "string" }, "total_fees_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on fees.", "readonly": true, "type": "string" }, "total_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of items in the order.", "readonly": true, "type": "string" }, "total_items_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on items in the order.", "readonly": true, "type": "string" }, "total_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price the customer will pay.", "readonly": true, "type": "string" }, "total_refund": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total refund applied to the order.", "readonly": true, "type": "string" }, "total_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total price of shipping.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "total_shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax applied to the order.", "readonly": true, "type": "string" @@ -6084,30 +9784,49 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "customer_note": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "type": "boolean" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order note was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order note was created, as GMT.", "readonly": true, "type": "date-time" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "note": { "context": ["view", "edit"], "description": "Order note content.", "type": "string" } + "note": { + "context": [ + "edit", + "view" + ], + "description": "Order note content.", + "type": "string" + } }, "title": "order_note", "type": "object" @@ -6119,7 +9838,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -6127,58 +9854,103 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", "rel": "https:/api.w.org/action-assign-author", - "targetSchema": { "properties": { "author": { "type": "integer" } }, "type": "object" }, + "targetSchema": { + "properties": { + "author": { + "type": "integer" + } + }, + "type": "object" + }, "title": "The current user can change the author on this post." } ], "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the post.", "type": "integer" }, "class_list": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of the class names for the post container element.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "comment_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -6187,34 +9959,61 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -6223,28 +10022,42 @@ "type": "object" }, "featured_media": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the featured media for the post.", "type": "integer" }, "generated_slug": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Slug automatically generated from the post title.", "readonly": true, "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -6254,106 +10067,165 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "menu_order": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The order of the post in relation to other posts.", "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", - "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "parent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The ID for the parent of the object.", "type": "integer" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "permalink_template": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Permalink template for the post.", "readonly": true, "type": "string" }, "ping_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -6362,7 +10234,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -6375,33 +10251,51 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -6410,34 +10304,55 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -6446,17 +10361,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -6466,56 +10389,95 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", - "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -6531,52 +10493,89 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "block_types": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "The block types which can use this pattern.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "uniqueItems": true }, "categories": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern's category slugs.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "uniqueItems": true }, "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern content.", "minLength": 1, "type": "string" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "A description of the pattern.", "minLength": 1, "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern ID.", "minimum": 1, "type": "integer" }, "keywords": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern's keywords.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "uniqueItems": true }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The pattern title, in human readable format.", "minLength": 1, "type": "string" }, "viewport_width": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The preferred width of the viewport when previewing a pattern, in pixels.", "type": "integer" } @@ -6594,35 +10593,77 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Suggestion description.", "readonly": true, "type": "string" }, - "id": { "context": ["view", "edit"], "description": "Suggestion ID.", "readonly": true, "type": "string" }, - "image": { "context": ["view", "edit"], "description": "Gateway image.", "readonly": true, "type": "string" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Suggestion ID.", + "readonly": true, + "type": "string" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Gateway image.", + "readonly": true, + "type": "string" + }, "is_visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Suggestion visibility.", "readonly": true, "type": "boolean" }, "plugins": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Array of plugin slugs.", "readonly": true, "type": "array" }, "recommendation_priority": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Priority of recommendation.", "readonly": true, "type": "integer" }, - "title": { "context": ["view", "edit"], "description": "Gateway title.", "readonly": true, "type": "string" }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Gateway title.", + "readonly": true, + "type": "string" + }, "transaction_processors": { - "addtionalProperties": { "format": "uri", "type": "string" }, - "context": ["view", "edit"], + "addtionalProperties": { + "format": "uri", + "type": "string" + }, + "context": [ + "edit", + "view" + ], "description": "Array of transaction processors and their images.", "readonly": true, "type": "object" @@ -6635,99 +10676,155 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway description on checkout.", "type": "string" }, "enabled": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway enabled status.", "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway ID.", "readonly": true, "type": "string" }, "method_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway method description.", "readonly": true, "type": "string" }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway method title.", "readonly": true, "type": "string" }, - "order": { "context": ["view", "edit"], "description": "Payment gateway sort order.", "type": "integer" }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway sort order.", + "type": "integer" + }, "settings": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", + "checkbox", "color", - "password", - "textarea", - "select", - "multiselect", - "radio", + "email", "image_width", - "checkbox" + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Setting value.", "type": "string" } + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } }, "type": "object" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment gateway title on checkout.", "type": "string" } @@ -6739,80 +10836,131 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin author.", "readonly": true, "type": "object" }, "author_uri": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin author's website address.", "format": "uri", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin description.", "properties": { - "raw": { "description": "The raw plugin description.", "type": "string" }, - "rendered": { "description": "The plugin description formatted for display.", "type": "string" } + "raw": { + "description": "The raw plugin description.", + "type": "string" + }, + "rendered": { + "description": "The plugin description formatted for display.", + "type": "string" + } }, "readonly": true, "type": "object" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The plugin name.", "readonly": true, "type": "string" }, "network_only": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the plugin can only be activated network wide.", "readonly": true, "type": "boolean" }, "plugin": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The plugin file.", "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", "readonly": true, "type": "string" }, "plugin_uri": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin's website address.", "format": "uri", "readonly": true, "type": "string" }, "requires_php": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Minimum required version of PHP.", "readonly": true, "type": "string" }, "requires_wp": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Minimum required version of WordPress.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The plugin activation status.", - "enum": ["inactive", "active"], + "enum": [ + "active", + "inactive" + ], "type": "string" }, "textdomain": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin's text domain.", "readonly": true, "type": "string" }, "version": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The plugin version number.", "readonly": true, "type": "string" @@ -6825,13 +10973,32 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "connectAction": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Action that should be completed to connect Jetpack.", "readonly": true, "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Plugin name.", "readonly": true, "type": "string" }, - "slug": { "context": ["view", "edit"], "description": "Plugin slug.", "readonly": true, "type": "string" } + "name": { + "context": [ + "edit", + "view" + ], + "description": "Plugin name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Plugin slug.", + "readonly": true, + "type": "string" + } }, "title": "plugins", "type": "object" @@ -6843,7 +11010,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -6851,26 +11026,56 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-sticky", - "targetSchema": { "properties": { "sticky": { "type": "boolean" } }, "type": "object" }, + "targetSchema": { + "properties": { + "sticky": { + "type": "boolean" + } + }, + "type": "object" + }, "title": "The current user can sticky this post." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-assign-author", - "targetSchema": { "properties": { "author": { "type": "integer" } }, "type": "object" }, + "targetSchema": { + "properties": { + "author": { + "type": "integer" + } + }, + "type": "object" + }, "title": "The current user can change the author on this post." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-assign-categories", "targetSchema": { - "properties": { "categories": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "categories": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the category taxonomy." @@ -6879,7 +11084,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-create-categories", "targetSchema": { - "properties": { "categories": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "categories": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the category taxonomy." @@ -6888,7 +11100,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-assign-tags", "targetSchema": { - "properties": { "tags": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "tags": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the post_tag taxonomy." @@ -6897,7 +11116,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", "rel": "https:/api.w.org/action-create-tags", "targetSchema": { - "properties": { "tags": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "tags": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the post_tag taxonomy." @@ -6905,52 +11131,86 @@ ], "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the post.", "type": "integer" }, "categories": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the category taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "class_list": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of the class names for the post container element.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "comment_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -6959,34 +11219,61 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -6995,34 +11282,62 @@ "type": "object" }, "featured_media": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the featured media for the post.", "type": "integer" }, "format": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The format for the post.", - "enum": ["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio"], + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], "type": "string" }, "generated_slug": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Slug automatically generated from the post title.", "readonly": true, "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -7032,107 +11347,168 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", - "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "permalink_template": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Permalink template for the post.", "readonly": true, "type": "string" }, "ping_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "sticky": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post should be treated as sticky.", "type": "boolean" }, "tags": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the post_tag taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -7141,7 +11517,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -7154,33 +11534,51 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -7189,34 +11587,55 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -7225,17 +11644,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -7245,56 +11672,95 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", - "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -7313,7 +11779,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -7321,14 +11795,30 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-assign-product_cat", "targetSchema": { - "properties": { "product_cat": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "product_cat": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the product_cat taxonomy." @@ -7337,7 +11827,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-create-product_cat", "targetSchema": { - "properties": { "product_cat": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "product_cat": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the product_cat taxonomy." @@ -7346,7 +11843,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-assign-product_tag", "targetSchema": { - "properties": { "product_tag": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "product_tag": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the product_tag taxonomy." @@ -7355,7 +11859,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", "rel": "https:/api.w.org/action-create-product_tag", "targetSchema": { - "properties": { "product_tag": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "product_tag": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the product_tag taxonomy." @@ -7363,35 +11874,54 @@ ], "properties": { "class_list": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An array of the class names for the post container element.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -7400,34 +11930,61 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -7436,28 +11993,42 @@ "type": "object" }, "featured_media": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID of the featured media for the post.", "type": "integer" }, "generated_slug": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Slug automatically generated from the post title.", "readonly": true, "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -7467,97 +12038,153 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "permalink_template": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Permalink template for the post.", "readonly": true, "type": "string" }, "product_cat": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the product_cat taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "product_tag": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the product_tag taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -7566,7 +12193,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -7579,48 +12210,94 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of objects (posts of any type) assigned to the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Term description.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Category image.", "properties": { - "alt": { "context": ["view", "edit"], "description": "Image alternative text.", "type": "string" }, - "id": { "context": ["view", "edit"], "description": "Image ID.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Image name.", "type": "string" }, + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, "sizes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail sizes for responsive images.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Full size image URL.", "format": "uri", "type": "string" }, "srcset": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail srcset for responsive images.", "type": "string" }, "thumbnail": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thumbnail URL.", "format": "uri", "type": "string" @@ -7629,28 +12306,49 @@ "readonly": true, "type": "object" }, - "name": { "context": ["view", "edit"], "description": "Term name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "readonly": true, + "type": "string" + }, "parent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent term ID, if applicable.", "readonly": true, "type": "integer" }, "permalink": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Category URL.", "format": "uri", "readonly": true, "type": "string" }, "review_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of reviews for products in this category.", "readonly": true, "type": "integer" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "String based identifier for the term.", "readonly": true, "type": "string" @@ -7663,98 +12361,157 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "attribute_counts": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Returns number of products within attribute terms.", "items": { "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of products.", "readonly": true, "type": "integer" }, - "term": { "context": ["view", "edit"], "description": "Term ID", "readonly": true, "type": "integer" } + "term": { + "context": [ + "edit", + "view" + ], + "description": "Term ID", + "readonly": true, + "type": "integer" + } }, "type": "object" }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "price_range": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Min and max prices found in collection of products, provided using the smallest unit of the currency.", "properties": { "currency_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency code (in ISO format) for returned prices.", "readonly": true, "type": "string" }, "currency_decimal_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Decimal separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_minor_unit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", "readonly": true, "type": "integer" }, "currency_prefix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_suffix": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Price prefix for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Currency symbol for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "currency_thousand_separator": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Thousand separator for the currency which can be used to format returned prices.", "readonly": true, "type": "string" }, "max_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Maximum price found in collection of products.", "readonly": true, "type": "string" }, "min_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Minimum price found in collection of products.", "readonly": true, "type": "string" } }, "readonly": true, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] }, "rating_counts": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Returns number of products with each average rating.", "items": { "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of products.", "readonly": true, "type": "integer" }, "rating": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average rating", "readonly": true, "type": "integer" @@ -7763,25 +12520,45 @@ "type": "object" }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "stock_status_counts": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Returns number of products with each stock status.", "items": { "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of products.", "readonly": true, "type": "integer" }, - "status": { "context": ["view", "edit"], "description": "Status", "readonly": true, "type": "string" } + "status": { + "context": [ + "edit", + "view" + ], + "description": "Status", + "readonly": true, + "type": "string" + } }, "type": "object" }, "readonly": true, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] } }, "title": "product-collection-data", @@ -7791,33 +12568,51 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -7826,34 +12621,55 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -7862,17 +12678,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -7882,51 +12706,89 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -7942,35 +12804,64 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "has_archives": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Enable/Disable attribute archives.", "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Attribute name.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, "order_by": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "menu_order", "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "select", "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "type": "string" } }, @@ -7981,30 +12872,52 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published products for the resource.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the resource.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "menu_order": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Term name.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "type": "string" + }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } @@ -8016,46 +12929,89 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, - "parent": { "context": ["view", "edit"], "description": "The parent term ID.", "type": "integer" }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The parent term ID.", + "type": "integer" + }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["product_cat"], + "enum": [ + "product_cat" + ], "readonly": true, "type": "string" } @@ -8067,27 +13023,67 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the review was created, in the site's timezone.", "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the review was created, as GMT.", "type": "date-time" }, - "email": { "context": ["view", "edit"], "description": "Reviewer email.", "type": "string" }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Reviewer email.", + "type": "string" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Reviewer name.", "type": "string" }, - "rating": { "context": ["view", "edit"], "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "context": ["view", "edit"], "description": "The content of the review.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "context": [ + "edit", + "view" + ], + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "context": [ + "edit", + "view" + ], + "description": "The content of the review.", + "type": "string" + }, "verified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the reviewer bought the product or not.", "readonly": true, "type": "boolean" @@ -8100,25 +13096,44 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published products for the resource.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the resource.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Shipping class name.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Shipping class name.", + "type": "string" + }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } @@ -8130,45 +13145,81 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["product_tag"], + "enum": [ + "product_tag" + ], "readonly": true, "type": "string" } @@ -8180,14 +13231,34 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of attributes.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Attribute ID.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Attribute name.", "type": "string" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -8197,231 +13268,487 @@ "type": "array" }, "backordered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on back-order.", "readonly": true, "type": "boolean" }, "backorders": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "type": "string" }, "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if back-orders are allowed.", "readonly": true, "type": "boolean" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_on_sale_from": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Start date of sale price, in the site's timezone.", "type": "date-time" }, "date_on_sale_from_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Start date of sale price, as GMT.", "type": "date-time" }, "date_on_sale_to": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "End date of sale price, in the site's timezone.", "type": "date-time" }, "date_on_sale_to_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "End date of sale price, as GMT.", "type": "date-time" }, - "description": { "context": ["view", "edit"], "description": "Variation description.", "type": "string" }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Variation description.", + "type": "string" + }, "dimensions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation dimensions.", "properties": { - "height": { "context": ["view", "edit"], "description": "Variation height (cm).", "type": "string" }, - "length": { "context": ["view", "edit"], "description": "Variation length (cm).", "type": "string" }, - "width": { "context": ["view", "edit"], "description": "Variation width (cm).", "type": "string" } + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } }, "type": "object" }, "download_expiry": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "download_limit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "downloadable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of downloadable files.", "items": { "properties": { - "file": { "context": ["view", "edit"], "description": "File URL.", "type": "string" }, - "id": { "context": ["view", "edit"], "description": "File ID.", "type": "string" }, - "name": { "context": ["view", "edit"], "description": "File name.", "type": "string" } + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } }, "type": "object" }, "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation image data.", "properties": { - "alt": { "context": ["view", "edit"], "description": "Image alternative text.", "type": "string" }, + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": "date-time" }, - "id": { "context": ["view", "edit"], "description": "Image ID.", "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Image name.", "type": "string" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, - "src": { "context": ["view", "edit"], "description": "Image URL.", "format": "uri", "type": "string" } + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } }, "type": "object" }, "in_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Stock management at variation level.", "type": "mixed" }, "menu_order": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Menu order, used to custom sort products.", "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "on_sale": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on sale.", "readonly": true, "type": "boolean" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation URL.", "format": "uri", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current variation price.", "readonly": true, "type": "string" }, "purchasable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation can be bought.", "readonly": true, "type": "boolean" }, - "regular_price": { "context": ["view", "edit"], "description": "Variation regular price.", "type": "string" }, - "sale_price": { "context": ["view", "edit"], "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "context": ["view", "edit"], "description": "Shipping class slug.", "type": "string" }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "context": [ + "edit", + "view" + ], + "description": "Shipping class slug.", + "type": "string" + }, "shipping_class_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping class ID.", "readonly": true, "type": "string" }, - "sku": { "context": ["view", "edit"], "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "context": ["view", "edit"], "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "context": ["view", "edit"], "description": "Tax class.", "type": "string" }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "context": [ + "edit", + "view" + ], + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class.", + "type": "string" + }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "type": "string" }, "virtual": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is virtual.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "context": ["view", "edit"], "description": "Variation weight (kg).", "type": "string" } + "weight": { + "context": [ + "edit", + "view" + ], + "description": "Variation weight (kg).", + "type": "string" + } }, "title": "product_variation", "type": "object" @@ -8429,7 +13756,14 @@ "rendered-block": { "$schema": "http:/json-schema.org/schema#", "properties": { - "rendered": { "context": ["edit"], "description": "The rendered block.", "required": true, "type": "string" } + "rendered": { + "context": [ + "edit" + ], + "description": "The rendered block.", + "required": true, + "type": "string" + } }, "title": "rendered-block", "type": "object" @@ -8438,13 +13772,17 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "A human-readable description of the resource.", "readonly": true, "type": "string" }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" @@ -8457,34 +13795,57 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "category_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "readonly": true, "type": "integer" }, "extended_info": { - "name": { "context": ["view", "edit"], "description": "Category name.", "readonly": true, "type": "string" } + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name.", + "readonly": true, + "type": "string" + } }, "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of items sold.", "readonly": true, "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "products_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of products.", "readonly": true, "type": "integer" @@ -8496,14 +13857,30 @@ "report_coupon_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Coupon type name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Coupon type name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of coupons.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of coupons.", + "readonly": true, + "type": "string" + } }, "title": "report_coupon_total", "type": "object" @@ -8512,53 +13889,89 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "readonly": true, "type": "number" }, "coupon_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon ID.", "readonly": true, "type": "integer" }, "extended_info": { - "code": { "context": ["view", "edit"], "description": "Coupon code.", "readonly": true, "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "readonly": true, + "type": "string" + }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon creation date.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon creation date in GMT.", "readonly": true, "type": "date-time" }, "date_expires": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon expiration date.", "readonly": true, "type": "date-time" }, "date_expires_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon expiration date in GMT.", "readonly": true, "type": "date-time" }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon discount type.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "readonly": true, "type": "string" } }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -8571,51 +13984,80 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "format": "currency", "indicator": true, @@ -8623,13 +14065,19 @@ "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of coupons.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of discounted orders.", "indicator": true, "readonly": true, @@ -8637,22 +14085,34 @@ "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "format": "currency", "indicator": true, @@ -8660,13 +14120,19 @@ "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of coupons.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of discounted orders.", "indicator": true, "readonly": true, @@ -8694,11 +14160,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "format": "currency", "indicator": true, @@ -8706,13 +14178,19 @@ "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of coupons.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of discounted orders.", "indicator": true, "readonly": true, @@ -8720,22 +14198,34 @@ "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net discount amount.", "format": "currency", "indicator": true, @@ -8743,13 +14233,19 @@ "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of coupons.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of discounted orders.", "indicator": true, "readonly": true, @@ -8777,14 +14273,30 @@ "report_customer_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Customer type name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Customer type name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of customers.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of customers.", + "readonly": true, + "type": "string" + } }, "title": "report_customer_total", "type": "object" @@ -8793,65 +14305,140 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "avg_order_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average order value", "readonly": true, "type": "number" }, - "city": { "context": ["view", "edit"], "description": "City.", "readonly": true, "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City.", + "readonly": true, + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region.", "readonly": true, "type": "string" }, "date_last_active": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date last active.", "readonly": true, "type": "date-time" }, "date_last_active_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date last active GMT.", "readonly": true, "type": "date-time" }, "date_registered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date registered.", "readonly": true, "type": "date-time" }, "date_registered_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date registered GMT.", "readonly": true, "type": "date-time" }, - "id": { "context": ["view", "edit"], "description": "Customer ID.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Name.", "readonly": true, "type": "string" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name.", + "readonly": true, + "type": "string" + }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order count.", "readonly": true, "type": "integer" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "readonly": true, "type": "string" }, - "state": { "context": ["view", "edit"], "description": "Region.", "readonly": true, "type": "string" }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "Region.", + "readonly": true, + "type": "string" + }, "total_spend": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total spend.", "readonly": true, "type": "number" }, - "user_id": { "context": ["view", "edit"], "description": "User ID.", "readonly": true, "type": "integer" }, - "username": { "context": ["view", "edit"], "description": "Username.", "readonly": true, "type": "string" } + "user_id": { + "context": [ + "edit", + "view" + ], + "description": "User ID.", + "readonly": true, + "type": "integer" + }, + "username": { + "context": [ + "edit", + "view" + ], + "description": "Username.", + "readonly": true, + "type": "string" + } }, "title": "report_customers", "type": "object" @@ -8860,31 +14447,46 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "avg_avg_order_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average AOV per customer.", "format": "currency", "readonly": true, "type": "number" }, "avg_orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average number of orders.", "readonly": true, "type": "integer" }, "avg_total_spend": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Average total spend per customer.", "format": "currency", "readonly": true, "type": "number" }, "customers_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of customers.", "readonly": true, "type": "integer" @@ -8901,53 +14503,109 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date of the download, in the site's time zone.", "readonly": true, "type": "date-time" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date of the download, as GMT.", "readonly": true, "type": "date-time" }, "download_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Download ID.", "readonly": true, "type": "string" }, - "file_name": { "context": ["view", "edit"], "description": "File name.", "readonly": true, "type": "string" }, - "file_path": { "context": ["view", "edit"], "description": "File URL.", "readonly": true, "type": "string" }, - "id": { "context": ["view", "edit"], "description": "ID.", "readonly": true, "type": "integer" }, + "file_name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "readonly": true, + "type": "string" + }, + "file_path": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "ID.", + "readonly": true, + "type": "integer" + }, "ip_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "IP address for the downloader.", "readonly": true, "type": "string" }, - "order_id": { "context": ["view", "edit"], "description": "Order ID.", "readonly": true, "type": "integer" }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, "order_number": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order Number.", "readonly": true, "type": "string" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "integer" }, "user_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "User ID for the downloader.", "readonly": true, "type": "integer" }, "username": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "User name of the downloader.", "readonly": true, "type": "string" @@ -8959,15 +14617,29 @@ "report_export": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "export_id": { "context": ["view", "edit"], "description": "Export ID.", "readonly": true, "type": "string" }, + "export_id": { + "context": [ + "edit", + "view" + ], + "description": "Export ID.", + "readonly": true, + "type": "string" + }, "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Export status message.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Export status.", "readonly": true, "type": "string" @@ -8980,13 +14652,19 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "download_url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Export download URL.", "readonly": true, "type": "string" }, "percent_complete": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Percentage complete.", "readonly": true, "type": "int" @@ -8999,13 +14677,19 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regenerate data message.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Regeneration status.", "readonly": true, "type": "string" @@ -9017,14 +14701,30 @@ "report_order_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Order status name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Order status name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of orders.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of orders.", + "readonly": true, + "type": "string" + } }, "title": "report_order_total", "type": "object" @@ -9033,77 +14733,129 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "customer_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Customer ID.", "readonly": true, "type": "integer" }, "customer_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Returning or new customer.", "readonly": true, "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date the order was created, in the site's time zone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Date the order was created, as GMT.", "readonly": true, "type": "date-time" }, "extended_info": { "attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order attribution information.", "readonly": true, "type": "object" }, "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of order coupons.", "readonly": true, "type": "array" }, "customer": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order customer information.", "readonly": true, "type": "object" }, "products": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of order product IDs, names, quantities.", "readonly": true, "type": "array" } }, "net_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net total revenue.", "readonly": true, "type": "float" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of items sold.", "readonly": true, "type": "integer" }, - "order_id": { "context": ["view", "edit"], "description": "Order ID.", "readonly": true, "type": "integer" }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, "order_number": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order Number.", "readonly": true, "type": "string" }, - "status": { "context": ["view", "edit"], "description": "Order status.", "readonly": true, "type": "string" }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Order status.", + "readonly": true, + "type": "string" + }, "total_formatted": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net total revenue (formatted).", "readonly": true, "type": "string" @@ -9116,47 +14868,76 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "readonly": true, "type": "date-time" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "readonly": true, "type": "date-time" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "readonly": true, "type": "date-time" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "readonly": true, "type": "date-time" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "download_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of downloads.", "indicator": true, "readonly": true, @@ -9174,11 +14955,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "download_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of downloads.", "indicator": true, "readonly": true, @@ -9197,36 +14984,45 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "chart": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The specific chart this stat referrers to.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable label for the stat.", "readonly": true, "type": "string" }, "stat": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "enum": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "readonly": true, "type": "string" @@ -9238,14 +15034,30 @@ "report_product_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Product type name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Product type name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of products.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of products.", + "readonly": true, + "type": "string" + } }, "title": "report_product_total", "type": "object" @@ -9255,76 +15067,128 @@ "properties": { "extended_info": { "category_ids": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product category IDs.", "readonly": true, "type": "array" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product image.", "readonly": true, "type": "string" }, "low_stock_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory threshold for low stock.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product link.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, - "sku": { "context": ["view", "edit"], "description": "Product SKU.", "readonly": true, "type": "string" }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, "stock_quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory quantity.", "readonly": true, "type": "integer" }, "stock_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory status.", "readonly": true, "type": "string" }, "variations": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product variations IDs.", "readonly": true, "type": "array" } }, "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of items sold.", "readonly": true, "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total Net sales of all items sold.", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders product appeared in.", "readonly": true, "type": "integer" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "integer" @@ -9337,51 +15201,80 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of product items sold.", "indicator": true, "readonly": true, @@ -9389,42 +15282,68 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "segment_label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable segment label, either product or variation name.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of product items sold.", "indicator": true, "readonly": true, @@ -9432,14 +15351,20 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -9465,11 +15390,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of product items sold.", "indicator": true, "readonly": true, @@ -9477,42 +15408,68 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "segment_label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable segment label, either product or variation name.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of product items sold.", "indicator": true, "readonly": true, @@ -9520,14 +15477,20 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -9554,64 +15517,99 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount discounted by coupons.", "readonly": true, "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique coupons count.", "format": "currency", "readonly": true, "type": "number" }, "gross_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Gross sales.", "format": "currency", "indicator": true, @@ -9619,7 +15617,10 @@ "type": "number" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "indicator": true, @@ -9627,19 +15628,28 @@ "type": "number" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Items sold.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of returns.", "format": "currency", "indicator": true, @@ -9648,35 +15658,53 @@ "type": "number" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount discounted by coupons.", "readonly": true, "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique coupons count.", "format": "currency", "readonly": true, "type": "number" }, "gross_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Gross sales.", "format": "currency", "indicator": true, @@ -9684,7 +15712,10 @@ "type": "number" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "indicator": true, @@ -9692,19 +15723,28 @@ "type": "number" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Items sold.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of returns.", "format": "currency", "indicator": true, @@ -9713,7 +15753,10 @@ "type": "number" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of shipping.", "format": "currency", "indicator": true, @@ -9722,14 +15765,20 @@ "type": "number" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of taxes.", "format": "currency", "readonly": true, "type": "number" }, "total_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "format": "currency", "indicator": true, @@ -9747,7 +15796,10 @@ "type": "array" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of shipping.", "format": "currency", "indicator": true, @@ -9756,14 +15808,20 @@ "type": "number" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of taxes.", "format": "currency", "readonly": true, "type": "number" }, "total_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "format": "currency", "indicator": true, @@ -9781,24 +15839,36 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount discounted by coupons.", "readonly": true, "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique coupons count.", "format": "currency", "readonly": true, "type": "number" }, "gross_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Gross sales.", "format": "currency", "indicator": true, @@ -9806,7 +15876,10 @@ "type": "number" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "indicator": true, @@ -9814,25 +15887,37 @@ "type": "number" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Items sold.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "products": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Products sold.", "readonly": true, "type": "integer" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of returns.", "format": "currency", "indicator": true, @@ -9841,35 +15926,53 @@ "type": "number" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "coupons": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount discounted by coupons.", "readonly": true, "type": "number" }, "coupons_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique coupons count.", "format": "currency", "readonly": true, "type": "number" }, "gross_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Gross sales.", "format": "currency", "indicator": true, @@ -9877,7 +15980,10 @@ "type": "number" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "indicator": true, @@ -9885,19 +15991,28 @@ "type": "number" }, "num_items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Items sold.", "readonly": true, "type": "integer" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of returns.", "format": "currency", "indicator": true, @@ -9906,7 +16021,10 @@ "type": "number" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of shipping.", "format": "currency", "indicator": true, @@ -9915,14 +16033,20 @@ "type": "number" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of taxes.", "format": "currency", "readonly": true, "type": "number" }, "total_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "format": "currency", "indicator": true, @@ -9940,7 +16064,10 @@ "type": "array" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of shipping.", "format": "currency", "indicator": true, @@ -9949,14 +16076,20 @@ "type": "number" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total of taxes.", "format": "currency", "readonly": true, "type": "number" }, "total_sales": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total sales.", "format": "currency", "indicator": true, @@ -9974,14 +16107,30 @@ "report_review_total": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Review type name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Review type name.", + "readonly": true, + "type": "string" + }, "slug": { - "context": ["view"], + "context": [ + "view" + ], "description": "An alphanumeric identifier for the resource.", "readonly": true, "type": "string" }, - "total": { "context": ["view"], "description": "Amount of reviews.", "readonly": true, "type": "string" } + "total": { + "context": [ + "view" + ], + "description": "Amount of reviews.", + "readonly": true, + "type": "string" + } }, "title": "report_review_total", "type": "object" @@ -9990,40 +16139,70 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "manage_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Manage stock.", "readonly": true, "type": "boolean" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, "parent_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product parent ID.", "readonly": true, "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier.", "readonly": true, "type": "string" }, "stock_quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock quantity.", "readonly": true, "type": "integer" }, "stock_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "readonly": true, "type": "string" } @@ -10035,35 +16214,95 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region.", "readonly": true, "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Tax rate name.", "readonly": true, "type": "string" }, - "order_tax": { "context": ["view", "edit"], "description": "Order tax.", "readonly": true, "type": "number" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate name.", + "readonly": true, + "type": "string" + }, + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "readonly": true, + "type": "number" + }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, - "priority": { "context": ["view", "edit"], "description": "Priority.", "readonly": true, "type": "integer" }, + "priority": { + "context": [ + "edit", + "view" + ], + "description": "Priority.", + "readonly": true, + "type": "integer" + }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "readonly": true, "type": "number" }, - "state": { "context": ["view", "edit"], "description": "State.", "readonly": true, "type": "string" }, - "tax_rate": { "context": ["view", "edit"], "description": "Tax rate.", "readonly": true, "type": "number" }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State.", + "readonly": true, + "type": "string" + }, + "tax_rate": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate.", + "readonly": true, + "type": "number" + }, "tax_rate_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, - "total_tax": { "context": ["view", "edit"], "description": "Total tax.", "readonly": true, "type": "number" } + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "readonly": true, + "type": "number" + } }, "title": "report_taxes", "type": "object" @@ -10072,51 +16311,80 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "order_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order tax.", "format": "currency", "indicator": true, @@ -10124,28 +16392,43 @@ "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "order_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order tax.", "format": "currency", "indicator": true, @@ -10153,13 +16436,19 @@ "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "format": "currency", "indicator": true, @@ -10167,13 +16456,19 @@ "type": "number" }, "tax_codes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of tax codes.", "readonly": true, "type": "integer" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax.", "format": "currency", "indicator": true, @@ -10191,7 +16486,10 @@ "type": "array" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "format": "currency", "indicator": true, @@ -10199,13 +16497,19 @@ "type": "number" }, "tax_codes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of tax codes.", "readonly": true, "type": "integer" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax.", "format": "currency", "indicator": true, @@ -10223,11 +16527,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "order_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order tax.", "format": "currency", "indicator": true, @@ -10235,28 +16545,43 @@ "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "order_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order tax.", "format": "currency", "indicator": true, @@ -10264,13 +16589,19 @@ "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "format": "currency", "indicator": true, @@ -10278,13 +16609,19 @@ "type": "number" }, "tax_codes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of tax codes.", "readonly": true, "type": "integer" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax.", "format": "currency", "indicator": true, @@ -10302,7 +16639,10 @@ "type": "array" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax.", "format": "currency", "indicator": true, @@ -10310,13 +16650,19 @@ "type": "number" }, "tax_codes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Amount of tax codes.", "readonly": true, "type": "integer" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total tax.", "format": "currency", "indicator": true, @@ -10335,51 +16681,80 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "intervals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by intervals.", "items": { "properties": { "date_end": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_end_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report end, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "date_start": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "date_start_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the report start, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "interval": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of interval.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of variation items sold.", "indicator": true, "readonly": true, @@ -10387,42 +16762,68 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "segment_label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable segment label, either product or variation name.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of variation items sold.", "indicator": true, "readonly": true, @@ -10430,14 +16831,20 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -10463,11 +16870,17 @@ "type": "array" }, "totals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Totals data.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of variation items sold.", "indicator": true, "readonly": true, @@ -10475,42 +16888,68 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" }, "segments": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Reports data grouped by segment condition.", "items": { "properties": { "segment_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Segment identificator.", "readonly": true, "type": "integer" }, "segment_label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Human readable segment label, either product or variation name.", - "enum": ["day", "week", "month", "year"], + "enum": [ + "day", + "month", + "week", + "year" + ], "readonly": true, "type": "string" }, "subtotals": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Interval subtotals.", "properties": { "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of variation items sold.", "indicator": true, "readonly": true, @@ -10518,14 +16957,20 @@ "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Net sales.", "format": "currency", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders.", "readonly": true, "type": "integer" @@ -10553,75 +16998,119 @@ "properties": { "extended_info": { "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product attributes.", "readonly": true, "type": "array" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product image.", "readonly": true, "type": "string" }, "low_stock_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory threshold for low stock.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product link.", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "stock_quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory quantity.", "readonly": true, "type": "integer" }, "stock_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product inventory status.", "readonly": true, "type": "string" } }, "items_sold": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of items sold.", "readonly": true, "type": "integer" }, "net_revenue": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total Net sales of all items sold.", "readonly": true, "type": "number" }, "orders_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of orders product appeared in.", "readonly": true, "type": "integer" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "integer" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "integer" @@ -10634,68 +17123,92 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "average_sales": { - "context": ["view"], + "context": [ + "view" + ], "description": "Average net daily sales.", "readonly": true, "type": "string" }, "net_sales": { - "context": ["view"], + "context": [ + "view" + ], "description": "Net sales in the period.", "readonly": true, "type": "string" }, "total_discount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total of coupons used.", "readonly": true, "type": "integer" }, "total_items": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total of items purchased.", "readonly": true, "type": "integer" }, "total_orders": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total of orders placed.", "readonly": true, "type": "integer" }, "total_refunds": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total of refunded orders.", "readonly": true, "type": "integer" }, "total_sales": { - "context": ["view"], + "context": [ + "view" + ], "description": "Gross sales in the period.", "readonly": true, "type": "string" }, "total_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total charged for shipping.", "readonly": true, "type": "string" }, "total_tax": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total charged for taxes.", "readonly": true, "type": "string" }, "totals": { - "context": ["view"], + "context": [ + "view" + ], "description": "Totals.", - "items": { "type": "array" }, + "items": { + "type": "array" + }, "readonly": true, "type": "array" }, "totals_grouped_by": { - "context": ["view"], + "context": [ + "view" + ], "description": "Group type.", "readonly": true, "type": "string" @@ -10708,33 +17221,63 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "Unique identifier for the object.", "readonly": true, - "type": ["integer", "string"] + "type": [ + "integer", + "string" + ] }, "subtype": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "Object subtype.", - "enum": ["post", "page", "product", "category", "post_tag", "product_cat", "product_tag"], + "enum": [ + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], "readonly": true, "type": "string" }, "title": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "The title for the object.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "Object type.", - "enum": ["post", "term", "post-format"], + "enum": [ + "post", + "post-format", + "term" + ], "readonly": true, "type": "string" }, "url": { - "context": ["view", "embed"], + "context": [ + "embed", + "view" + ], "description": "URL to the object.", "format": "uri", "readonly": true, @@ -10748,68 +17291,99 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "mixed" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.", "readonly": true, "type": "object" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea", "thumbnail_cropping" ], "readonly": true, "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Setting value.", "type": "mixed" } + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "mixed" + } }, "title": "setting", "type": "object" @@ -10818,31 +17392,41 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view"], + "context": [ + "view" + ], "description": "A unique identifier that can be used to link settings together.", "readonly": true, "type": "string" }, "label": { - "context": ["view"], + "context": [ + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "parent_id": { - "context": ["view"], + "context": [ + "view" + ], "description": "ID of parent grouping.", "readonly": true, "type": "string" }, "sub_groups": { - "context": ["view"], + "context": [ + "view" + ], "description": "IDs for settings sub groups.", "readonly": true, "type": "string" @@ -10869,14 +17453,20 @@ "default_comment_status": { "default": null, "description": "Allow people to submit comments on new posts.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "title": "Allow comments on new posts", "type": "string" }, "default_ping_status": { "default": null, "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "title": "", "type": "string" }, @@ -10886,7 +17476,12 @@ "title": "", "type": "string" }, - "description": { "default": null, "description": "Site tagline.", "title": "Tagline", "type": "string" }, + "description": { + "default": null, + "description": "Site tagline.", + "title": "Tagline", + "type": "string" + }, "email": { "default": null, "description": "This address is used for admin purposes, like new user notification.", @@ -10894,7 +17489,12 @@ "title": "", "type": "string" }, - "language": { "default": "en_US", "description": "WordPress locale code.", "title": "", "type": "string" }, + "language": { + "default": "en_US", + "description": "WordPress locale code.", + "title": "", + "type": "string" + }, "page_for_posts": { "default": null, "description": "The ID of the page that should display the latest posts", @@ -10912,15 +17512,24 @@ "default": [], "description": "WooCommerce Local Pickup Method Settings", "properties": { - "cost": { "description": "Optional cost to charge for local pickup.", "type": "string" }, + "cost": { + "description": "Optional cost to charge for local pickup.", + "type": "string" + }, "enabled": { "description": "If enabled, this method will appear on the block based checkout.", - "enum": ["yes", "no"], + "enum": [ + "no", + "yes" + ], "type": "string" }, "tax_status": { "description": "If a cost is defined, this controls if taxes are applied to that cost.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "title": { @@ -10940,17 +17549,33 @@ "address": { "additionalProperties": false, "properties": { - "address_1": { "type": "string" }, - "city": { "type": "string" }, - "country": { "type": "string" }, - "postcode": { "type": "string" }, - "state": { "type": "string" } + "address_1": { + "type": "string" + }, + "city": { + "type": "string" + }, + "country": { + "type": "string" + }, + "postcode": { + "type": "string" + }, + "state": { + "type": "string" + } }, "type": "object" }, - "details": { "type": "string" }, - "enabled": { "type": "boolean" }, - "name": { "type": "string" } + "details": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "name": { + "type": "string" + } }, "type": "object" }, @@ -10969,8 +17594,18 @@ "title": "Show on front", "type": "string" }, - "site_icon": { "default": null, "description": "Site icon.", "title": "Icon", "type": "integer" }, - "site_logo": { "default": null, "description": "Site logo.", "title": "Logo", "type": "integer" }, + "site_icon": { + "default": null, + "description": "Site icon.", + "title": "Icon", + "type": "integer" + }, + "site_logo": { + "default": null, + "description": "Site logo.", + "title": "Logo", + "type": "integer" + }, "start_of_week": { "default": null, "description": "A day number of the week that the week should start on.", @@ -10989,8 +17624,19 @@ "title": "", "type": "string" }, - "title": { "default": null, "description": "Site title.", "title": "Title", "type": "string" }, - "url": { "default": null, "description": "Site URL.", "format": "uri", "title": "", "type": "string" }, + "title": { + "default": null, + "description": "Site title.", + "title": "Title", + "type": "string" + }, + "url": { + "default": null, + "description": "Site URL.", + "format": "uri", + "title": "", + "type": "string" + }, "use_smilies": { "default": true, "description": "Convert emoticons like :-) and :-P to graphics on display.", @@ -11005,23 +17651,45 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "items": [ { - "anyOf": [{ "required": "layout_row" }, { "required": "layout_column" }], + "anyOf": [ + { + "required": "layout_row" + }, + { + "required": "layout_column" + } + ], "properties": { "available_layouts": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Available layouts -- single, dual, or both", - "items": { "enum": ["row", "column"], "type": "string" }, + "items": { + "enum": [ + "column", + "row" + ], + "type": "string" + }, "readonly": true, "type": "array" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Description", "readonly": true, "type": "string" }, "is_visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Suggestion visibility.", "readonly": true, "type": "boolean" @@ -11031,15 +17699,24 @@ "features": { "items": { "properties": { - "description": { "type": "string" }, - "icon": { "type": "string" }, - "title": { "type": "string" } + "description": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "title": { + "type": "string" + } }, "type": "object" }, "type": "array" }, - "image": { "description": "", "type": "string" } + "image": { + "description": "", + "type": "string" + } }, "type": "object" }, @@ -11048,39 +17725,61 @@ "features": { "items": { "properties": { - "description": { "type": "string" }, - "icon": { "type": "string" }, - "title": { "type": "string" } + "description": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "title": { + "type": "string" + } }, "type": "object" }, "type": "array" }, - "image": { "description": "", "type": "string" } + "image": { + "description": "", + "type": "string" + } }, "type": "object" }, "learn_more_link": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Learn more link .", "readonly": true, "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Plugin name.", "readonly": true, "required": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Plugin slug used in https:/wordpress.org/plugins/{slug}.", "readonly": true, "type": "string" } }, - "required": ["name", "is_visible", "available_layouts"], + "required": [ + "available_layouts", + "is_visible", + "name" + ], "type": "object" } ], @@ -11091,13 +17790,29 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "description": { - "context": ["view"], + "context": [ + "view" + ], "description": "Shipping method description.", "readonly": true, "type": "string" }, - "id": { "context": ["view"], "description": "Method ID.", "readonly": true, "type": "string" }, - "title": { "context": ["view"], "description": "Shipping method title.", "readonly": true, "type": "string" } + "id": { + "context": [ + "view" + ], + "description": "Method ID.", + "readonly": true, + "type": "string" + }, + "title": { + "context": [ + "view" + ], + "description": "Shipping method title.", + "readonly": true, + "type": "string" + } }, "title": "shipping_method", "type": "object" @@ -11106,13 +17821,30 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Shipping zone name.", "type": "string" }, - "order": { "context": ["view", "edit"], "description": "Shipping zone order.", "type": "integer" } + "name": { + "context": [ + "edit", + "view" + ], + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Shipping zone order.", + "type": "integer" + } }, "title": "shipping_zone", "type": "object" @@ -11120,12 +17852,27 @@ "shipping_zone_location": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "code": { "context": ["view", "edit"], "description": "Shipping zone location code.", "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Shipping zone location code.", + "type": "string" + }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "country", "description": "Shipping zone location type.", - "enum": ["postcode", "state", "country", "continent"], + "enum": [ + "continent", + "country", + "postcode", + "state" + ], "type": "string" } }, @@ -11136,106 +17883,165 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "enabled": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method enabled status.", "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method instance ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method instance ID.", "readonly": true, "type": "integer" }, "method_description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method description.", "readonly": true, "type": "string" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", "readonly": true, "type": "string" }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method title.", "readonly": true, "type": "string" }, - "order": { "context": ["view", "edit"], "description": "Shipping method sort order.", "type": "integer" }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method sort order.", + "type": "integer" + }, "settings": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", + "checkbox", "color", - "password", - "textarea", - "select", - "multiselect", - "radio", + "email", "image_width", - "checkbox" + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Setting value.", "type": "string" } + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } }, "type": "object" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method customer facing title.", "readonly": true, "type": "string" @@ -11248,160 +18054,290 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "context": ["view", "edit"], "description": "Coupon code.", "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": "string" + }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon was created, as GMT.", "readonly": true, "type": "date-time" }, "date_expires": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon expires, in the site's timezone.", "type": "date-time" }, "date_expires_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon expires, as GMT.", "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the coupon was last modified, as GMT.", "readonly": true, "type": "date-time" }, - "description": { "context": ["view", "edit"], "description": "Coupon description.", "type": "string" }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Coupon description.", + "type": "string" + }, "discount_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "type": "string" }, "email_restrictions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of email addresses that can use this coupon.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, "exclude_sale_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean" }, "excluded_product_categories": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of category IDs the coupon does not apply to.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "excluded_product_ids": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of product IDs the coupon cannot be used on.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "free_shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the object.", "readonly": true, "type": "integer" }, "individual_use": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean" }, "limit_usage_to_x_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer" }, "maximum_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "minimum_amount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" }, "product_categories": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of category IDs the coupon applies to.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "product_ids": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of product IDs the coupon can be used on.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" }, "usage_count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of times the coupon has been used already.", "readonly": true, "type": "integer" }, "usage_limit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How many times the coupon can be used in total.", "type": "integer" }, "usage_limit_per_user": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "How many times the coupon can be used per customer.", "type": "integer" }, "used_by": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of user IDs (or guest email addresses) that have used the coupon.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "readonly": true, "type": "array" } @@ -11413,30 +18349,101 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "billing": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Billing address.", "properties": { - "address_1": { "context": ["view", "edit"], "description": "Address line 1", "type": "string" }, - "address_2": { "context": ["view", "edit"], "description": "Address line 2", "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company name.", "type": "string" }, + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name.", + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name.", + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone number.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "First name.", "type": "string" }, - "last_name": { "context": ["view", "edit"], "description": "Last name.", "type": "string" }, - "phone": { "context": ["view", "edit"], "description": "Phone number.", "type": "string" }, - "postcode": { "context": ["view", "edit"], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -11444,63 +18451,123 @@ "type": "object" }, "cart_hash": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "MD5 hash of basket items to ensure orders are not modified.", "readonly": true, "type": "string" }, "cart_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sum of line item taxes only.", "readonly": true, "type": "string" }, "coupon_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupons line data.", "items": { "properties": { - "code": { "context": ["view", "edit"], "description": "Coupon code.", "type": "mixed" }, - "discount": { "context": ["view", "edit"], "description": "Discount total.", "type": "string" }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": "mixed" + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -11511,13 +18578,19 @@ "type": "array" }, "created_via": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows where the order was created.", "readonly": true, "type": "string" }, "currency": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "EUR", "description": "Currency the order was created with, in ISO format.", "enum": [ @@ -11545,8 +18618,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -11688,139 +18761,244 @@ "type": "string" }, "customer_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": 0, "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, "customer_ip_address": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Customer's IP address.", "readonly": true, "type": "string" }, "customer_note": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Note left by customer during checkout.", "type": "string" }, "customer_user_agent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "User agent of the customer.", "readonly": true, "type": "string" }, "date_completed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was completed, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_completed_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was completed, as GMT.", "readonly": true, "type": "date-time" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was created, as GMT.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was last modified, as GMT.", "readonly": true, "type": "date-time" }, "date_paid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was paid, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_paid_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order was paid, as GMT.", "readonly": true, "type": "date-time" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount tax amount for the order.", "readonly": true, "type": "string" }, "discount_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total discount amount for the order.", "readonly": true, "type": "string" }, "fee_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee lines data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "name": { "context": ["view", "edit"], "description": "Fee name.", "type": "mixed" }, - "tax_class": { "context": ["view", "edit"], "description": "Tax class of fee.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": "mixed" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -11832,12 +19010,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -11848,30 +19032,60 @@ "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "is_editable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether an order can be edited.", "readonly": true, "type": "boolean" }, "line_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line items data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { - "id": { "context": ["view", "edit"], "description": "Image ID.", "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -11881,73 +19095,166 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "name": { "context": ["view", "edit"], "description": "Product name.", "type": "mixed" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": "mixed" + }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, - "product_id": { "context": ["view", "edit"], "description": "Product ID.", "type": "mixed" }, - "quantity": { "context": ["view", "edit"], "description": "Quantity ordered.", "type": "integer" }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": "mixed" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, - "tax_class": { "context": ["view", "edit"], "description": "Tax class of product.", "type": "string" }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Tax rate ID", "type": "integer" }, - "subtotal": { "context": ["view", "edit"], "description": "Tax subtotal.", "type": "string" }, - "total": { "context": ["view", "edit"], "description": "Tax total.", "type": "string" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "type": "string" + } }, "type": "object" }, @@ -11955,18 +19262,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -11976,65 +19292,152 @@ "type": "array" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "needs_payment": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether an order needs payment, based on status and order total.", "readonly": true, "type": "boolean" }, "needs_processing": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether an order needs processing before it can be completed.", "readonly": true, "type": "boolean" }, - "number": { "context": ["view", "edit"], "description": "Order number.", "readonly": true, "type": "string" }, - "order_key": { "context": ["view", "edit"], "description": "Order key.", "readonly": true, "type": "string" }, - "parent_id": { "context": ["view", "edit"], "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "context": ["view", "edit"], "description": "Payment method ID.", "type": "string" }, + "number": { + "context": [ + "edit", + "view" + ], + "description": "Order number.", + "readonly": true, + "type": "string" + }, + "order_key": { + "context": [ + "edit", + "view" + ], + "description": "Order key.", + "readonly": true, + "type": "string" + }, + "parent_id": { + "context": [ + "edit", + "view" + ], + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "context": [ + "edit", + "view" + ], + "description": "Payment method ID.", + "type": "string" + }, "payment_method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Payment method title.", "type": "string" }, "payment_url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Order payment URL.", "readonly": true, "type": "string" }, "prices_include_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "True the prices included tax during checkout.", "readonly": true, "type": "boolean" }, "refunds": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of refunds.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Refund ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Refund ID.", + "readonly": true, + "type": "integer" + }, "reason": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Refund reason.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Refund total.", "readonly": true, "type": "string" @@ -12046,29 +19449,89 @@ "type": "array" }, "set_paid": { - "context": ["edit"], + "context": [ + "edit" + ], "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping address.", "properties": { - "address_1": { "context": ["view", "edit"], "description": "Address line 1", "type": "string" }, - "address_2": { "context": ["view", "edit"], "description": "Address line 2", "type": "string" }, - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, - "company": { "context": ["view", "edit"], "description": "Company name.", "type": "string" }, + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" + }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, - "first_name": { "context": ["view", "edit"], "description": "First name.", "type": "string" }, - "last_name": { "context": ["view", "edit"], "description": "Last name.", "type": "string" }, - "postcode": { "context": ["view", "edit"], "description": "Postal code.", "type": "string" }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name.", + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" + }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -12076,53 +19539,106 @@ "type": "object" }, "shipping_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping lines data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "method_id": { "context": ["view", "edit"], "description": "Shipping method ID.", "type": "mixed" }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": "mixed" + }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", "type": "mixed" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -12134,12 +19650,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -12150,90 +19672,148 @@ "type": "array" }, "shipping_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total shipping tax amount for the order.", "readonly": true, "type": "string" }, "shipping_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Total shipping amount for the order.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "pending", "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "type": "string" }, "tax_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax lines data.", "items": { "properties": { "compound": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Show if is a compound tax rate.", "readonly": true, "type": "boolean" }, - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate label.", "readonly": true, "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "rate_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate code.", "readonly": true, "type": "string" }, "rate_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "shipping_tax_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax total.", "readonly": true, "type": "string" }, "tax_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total (not including shipping taxes).", "readonly": true, "type": "string" @@ -12244,16 +19824,37 @@ "readonly": true, "type": "array" }, - "total": { "context": ["view", "edit"], "description": "Grand total.", "readonly": true, "type": "string" }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Grand total.", + "readonly": true, + "type": "string" + }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Sum of all taxes.", "readonly": true, "type": "string" }, - "transaction_id": { "context": ["view", "edit"], "description": "Unique transaction ID.", "type": "string" }, + "transaction_id": { + "context": [ + "edit", + "view" + ], + "description": "Unique transaction ID.", + "type": "string" + }, "version": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Version of WooCommerce which last updated the order.", "readonly": true, "type": "string" @@ -12265,76 +19866,154 @@ "shop_order_refund": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "amount": { "context": ["view", "edit"], "description": "Refund amount.", "type": "string" }, + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Refund amount.", + "type": "string" + }, "api_refund": { - "context": ["edit"], + "context": [ + "edit" + ], "default": true, "description": "When true, the payment gateway API is used to generate the refund.", "type": "boolean" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order refund was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the order refund was created, as GMT.", "readonly": true, "type": "date-time" }, "fee_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee lines data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "name": { "context": ["view", "edit"], "description": "Fee name.", "type": "mixed" }, - "tax_class": { "context": ["view", "edit"], "description": "Tax class of fee.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": "mixed" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -12346,12 +20025,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -12362,36 +20047,62 @@ "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, "line_items": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line items data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", "readonly": true, "type": "mixed" @@ -12403,72 +20114,108 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, "type": "mixed" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", "readonly": true, "type": "mixed" }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "readonly": true, "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "readonly": true, "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "readonly": true, "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -12480,19 +20227,28 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "readonly": true, "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "readonly": true, "type": "integer" @@ -12504,78 +20260,169 @@ "type": "array" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "reason": { "context": ["view", "edit"], "description": "Reason for refund.", "type": "string" }, + "reason": { + "context": [ + "edit", + "view" + ], + "description": "Reason for refund.", + "type": "string" + }, "refunded_by": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "User ID of user who created the refund.", "type": "integer" }, "refunded_payment": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If the payment was refunded via the API.", "readonly": true, "type": "boolean" }, "shipping_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping lines data.", "items": { "properties": { - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, - "method_id": { "context": ["view", "edit"], "description": "Shipping method ID.", "type": "mixed" }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": "mixed" + }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", "type": "mixed" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -12587,12 +20434,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -12603,61 +20456,110 @@ "type": "array" }, "tax_lines": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax lines data.", "items": { "properties": { "compound": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Show if is a compound tax rate.", "readonly": true, "type": "boolean" }, - "id": { "context": ["view", "edit"], "description": "Item ID.", "readonly": true, "type": "integer" }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate label.", "readonly": true, "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, - "key": { "context": ["view", "edit"], "description": "Meta key.", "type": "string" }, - "value": { "context": ["view", "edit"], "description": "Meta value.", "type": "mixed" } + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": "mixed" + } }, "type": "object" }, "type": "array" }, "rate_code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate code.", "readonly": true, "type": "string" }, "rate_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "shipping_tax_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping tax total.", "readonly": true, "type": "string" }, "tax_total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total (not including shipping taxes).", "readonly": true, "type": "string" @@ -12676,69 +20578,117 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "after_title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "HTML content to append to the sidebar title when displayed. Default is a closing h2 element.", "readonly": true, "type": "string" }, "after_widget": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.", "readonly": true, "type": "string" }, "before_title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.", "readonly": true, "type": "string" }, "before_widget": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.", "readonly": true, "type": "string" }, "class": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Extra CSS class to assign to the sidebar in the Widgets interface.", "readonly": true, "type": "string" }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Description of sidebar.", "readonly": true, "type": "string" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of sidebar.", "readonly": true, "type": "string" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique name identifying the sidebar.", "readonly": true, "type": "string" }, "status": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Status of sidebar.", - "enum": ["active", "inactive"], + "enum": [ + "active", + "inactive" + ], "readonly": true, "type": "string" }, "widgets": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": [], "description": "Nested widgets.", - "items": { "type": ["object", "string"] }, + "items": { + "type": [ + "object", + "string" + ] + }, "type": "array" } }, @@ -12749,49 +20699,72 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date_floating": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether posts of this status may have floating published dates.", "readonly": true, "type": "boolean" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the status.", "readonly": true, "type": "string" }, "private": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether posts with this status should be private.", "readonly": true, "type": "boolean" }, "protected": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether posts with this status should be protected.", "readonly": true, "type": "boolean" }, "public": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether posts of this status should be shown in the front end of the site.", "readonly": true, "type": "boolean" }, "queryable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether posts with this status should be publicly-queryable.", "readonly": true, "type": "boolean" }, "show_in_list": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether to include posts in the edit listing for their post type.", "readonly": true, "type": "boolean" }, "slug": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the status.", "readonly": true, "type": "string" @@ -12804,37 +20777,53 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "active_plugins": { - "context": ["view"], + "context": [ + "view" + ], "description": "Active plugins.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "database": { - "context": ["view"], + "context": [ + "view" + ], "description": "Database.", "properties": { "database_prefix": { - "context": ["view"], + "context": [ + "view" + ], "description": "Database prefix.", "readonly": true, "type": "string" }, "database_tables": { - "context": ["view"], + "context": [ + "view" + ], "description": "Database tables.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "maxmind_geoip_database": { - "context": ["view"], + "context": [ + "view" + ], "description": "MaxMind GeoIP database.", "readonly": true, "type": "string" }, "wc_database_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "WC database version.", "readonly": true, "type": "string" @@ -12844,196 +20833,276 @@ "type": "object" }, "dropins_mu_plugins": { - "context": ["view"], + "context": [ + "view" + ], "description": "Dropins & MU plugins.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "environment": { - "context": ["view"], + "context": [ + "view" + ], "description": "Environment.", "properties": { "curl_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "cURL version.", "readonly": true, "type": "string" }, "default_timezone": { - "context": ["view"], + "context": [ + "view" + ], "description": "Default timezone.", "readonly": true, "type": "string" }, "domdocument_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is DomDocument class enabled?", "readonly": true, "type": "boolean" }, "fsockopen_or_curl_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is fsockopen/cURL enabled?", "readonly": true, "type": "boolean" }, "gzip_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is GZip enabled?", "readonly": true, "type": "boolean" }, "home_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Home URL.", "format": "uri", "readonly": true, "type": "string" }, "language": { - "context": ["view"], + "context": [ + "view" + ], "description": "WordPress language.", "readonly": true, "type": "string" }, "log_directory": { - "context": ["view"], + "context": [ + "view" + ], "description": "Log directory.", "readonly": true, "type": "string" }, "log_directory_writable": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is log directory writable?", "readonly": true, "type": "boolean" }, "max_upload_size": { - "context": ["view"], + "context": [ + "view" + ], "description": "Max upload size.", "readonly": true, "type": "integer" }, "mbstring_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is mbstring enabled?", "readonly": true, "type": "boolean" }, "mysql_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "MySQL version.", "readonly": true, "type": "string" }, "mysql_version_string": { - "context": ["view"], + "context": [ + "view" + ], "description": "MySQL version string.", "readonly": true, "type": "string" }, "php_max_execution_time": { - "context": ["view"], + "context": [ + "view" + ], "description": "PHP max execution time.", "readonly": true, "type": "integer" }, "php_max_input_vars": { - "context": ["view"], + "context": [ + "view" + ], "description": "PHP max input vars.", "readonly": true, "type": "integer" }, "php_post_max_size": { - "context": ["view"], + "context": [ + "view" + ], "description": "PHP post max size.", "readonly": true, "type": "integer" }, - "php_version": { "context": ["view"], "description": "PHP version.", "readonly": true, "type": "string" }, + "php_version": { + "context": [ + "view" + ], + "description": "PHP version.", + "readonly": true, + "type": "string" + }, "remote_get_response": { - "context": ["view"], + "context": [ + "view" + ], "description": "Remote GET response.", "readonly": true, "type": "string" }, "remote_get_successful": { - "context": ["view"], + "context": [ + "view" + ], "description": "Remote GET successful?", "readonly": true, "type": "boolean" }, "remote_post_response": { - "context": ["view"], + "context": [ + "view" + ], "description": "Remote POST response.", "readonly": true, "type": "string" }, "remote_post_successful": { - "context": ["view"], + "context": [ + "view" + ], "description": "Remote POST successful?", "readonly": true, "type": "boolean" }, - "server_info": { "context": ["view"], "description": "Server info.", "readonly": true, "type": "string" }, + "server_info": { + "context": [ + "view" + ], + "description": "Server info.", + "readonly": true, + "type": "string" + }, "site_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Site URL.", "format": "uri", "readonly": true, "type": "string" }, "soapclient_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is SoapClient class enabled?", "readonly": true, "type": "boolean" }, "store_id": { - "context": ["view"], + "context": [ + "view" + ], "description": "WooCommerce Store Identifier.", "readonly": true, "type": "string" }, "suhosin_installed": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is SUHOSIN installed?", "readonly": true, "type": "boolean" }, "version": { - "context": ["view"], + "context": [ + "view" + ], "description": "WooCommerce version.", "readonly": true, "type": "string" }, "wp_cron": { - "context": ["view"], + "context": [ + "view" + ], "description": "Are WordPress cron jobs enabled?", "readonly": true, "type": "boolean" }, "wp_debug_mode": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is WordPress debug mode active?", "readonly": true, "type": "boolean" }, "wp_memory_limit": { - "context": ["view"], + "context": [ + "view" + ], "description": "WordPress memory limit.", "readonly": true, "type": "integer" }, "wp_multisite": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is WordPress multisite?", "readonly": true, "type": "boolean" }, "wp_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "WordPress version.", "readonly": true, "type": "string" @@ -13043,42 +21112,58 @@ "type": "object" }, "inactive_plugins": { - "context": ["view"], + "context": [ + "view" + ], "description": "Inactive plugins.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "logging": { - "context": ["view"], + "context": [ + "view" + ], "description": "Logging.", "properties": { "default_handler": { - "context": ["view"], + "context": [ + "view" + ], "description": "The logging handler class.", "readonly": true, "type": "string" }, "level_threshold": { - "context": ["view"], + "context": [ + "view" + ], "description": "Minimum severity level.", "readonly": true, "type": "string" }, "log_directory_size": { - "context": ["view"], + "context": [ + "view" + ], "description": "The size of the log directory.", "readonly": true, "type": "string" }, "logging_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is logging enabled?", "readonly": true, "type": "boolean" }, "retention_period_days": { - "context": ["view"], + "context": [ + "view" + ], "description": "The number of days log entries are retained.", "readonly": true, "type": "integer" @@ -13088,31 +21173,45 @@ "type": "object" }, "pages": { - "context": ["view"], + "context": [ + "view" + ], "description": "WooCommerce pages.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "post_type_counts": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total post count.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "security": { - "context": ["view"], + "context": [ + "view" + ], "description": "Security.", "properties": { "hide_errors": { - "context": ["view"], + "context": [ + "view" + ], "description": "Hide errors from visitors?", "readonly": true, "type": "boolean" }, "secure_connection": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is the connection to your store secure?", "readonly": true, "type": "boolean" @@ -13122,93 +21221,141 @@ "type": "object" }, "settings": { - "context": ["view"], + "context": [ + "view" + ], "description": "Settings.", "properties": { "HPOS_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is HPOS enabled?", "readonly": true, "type": "boolean" }, "HPOS_sync_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is HPOS sync enabled?", "readonly": true, "type": "boolean" }, "api_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Legacy REST API enabled?", "readonly": true, "type": "boolean" }, - "currency": { "context": ["view"], "description": "Currency.", "readonly": true, "type": "string" }, + "currency": { + "context": [ + "view" + ], + "description": "Currency.", + "readonly": true, + "type": "string" + }, "currency_position": { - "context": ["view"], + "context": [ + "view" + ], "description": "Currency position.", "readonly": true, "type": "string" }, "currency_symbol": { - "context": ["view"], + "context": [ + "view" + ], "description": "Currency symbol.", "readonly": true, "type": "string" }, "decimal_separator": { - "context": ["view"], + "context": [ + "view" + ], "description": "Decimal separator.", "readonly": true, "type": "string" }, "enforce_approved_download_dirs": { - "context": ["view"], + "context": [ + "view" + ], "description": "Enforce approved download directories?", "readonly": true, "type": "boolean" }, - "force_ssl": { "context": ["view"], "description": "SSL forced?", "readonly": true, "type": "boolean" }, + "force_ssl": { + "context": [ + "view" + ], + "description": "SSL forced?", + "readonly": true, + "type": "boolean" + }, "geolocation_enabled": { - "context": ["view"], + "context": [ + "view" + ], "description": "Geolocation enabled?", "readonly": true, "type": "boolean" }, "number_of_decimals": { - "context": ["view"], + "context": [ + "view" + ], "description": "Number of decimals.", "readonly": true, "type": "integer" }, "order_datastore": { - "context": ["view"], + "context": [ + "view" + ], "description": "Order datastore.", "readonly": true, "type": "string" }, "product_visibility_terms": { - "context": ["view"], + "context": [ + "view" + ], "description": "Terms in the product visibility taxonomy.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "taxonomies": { - "context": ["view"], + "context": [ + "view" + ], "description": "Taxonomy terms for product/order statuses.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "thousand_separator": { - "context": ["view"], + "context": [ + "view" + ], "description": "Thousand separator.", "readonly": true, "type": "string" }, "wccom_connected": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is store connected to WooCommerce.com?", "readonly": true, "type": "string" @@ -13218,70 +21365,108 @@ "type": "object" }, "theme": { - "context": ["view"], + "context": [ + "view" + ], "description": "Theme.", "properties": { "author_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Theme author URL.", "format": "uri", "readonly": true, "type": "string" }, "has_outdated_templates": { - "context": ["view"], + "context": [ + "view" + ], "description": "Does this theme have outdated templates?", "readonly": true, "type": "boolean" }, "has_woocommerce_file": { - "context": ["view"], + "context": [ + "view" + ], "description": "Does the theme have a woocommerce.php file?", "readonly": true, "type": "boolean" }, "has_woocommerce_support": { - "context": ["view"], + "context": [ + "view" + ], "description": "Does the theme declare WooCommerce support?", "readonly": true, "type": "boolean" }, "is_child_theme": { - "context": ["view"], + "context": [ + "view" + ], "description": "Is this theme a child theme?", "readonly": true, "type": "boolean" }, - "name": { "context": ["view"], "description": "Theme name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "view" + ], + "description": "Theme name.", + "readonly": true, + "type": "string" + }, "overrides": { - "context": ["view"], + "context": [ + "view" + ], "description": "Template overrides.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "parent_author_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "Parent theme author URL.", "format": "uri", "readonly": true, "type": "string" }, "parent_name": { - "context": ["view"], + "context": [ + "view" + ], "description": "Parent theme name.", "readonly": true, "type": "string" }, "parent_version": { - "context": ["view"], + "context": [ + "view" + ], "description": "Parent theme version.", "readonly": true, "type": "string" }, - "version": { "context": ["view"], "description": "Theme version.", "readonly": true, "type": "string" }, + "version": { + "context": [ + "view" + ], + "description": "Theme version.", + "readonly": true, + "type": "string" + }, "version_latest": { - "context": ["view"], + "context": [ + "view" + ], "description": "Latest version of theme.", "readonly": true, "type": "string" @@ -13297,12 +21482,52 @@ "system_status_tool": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "action": { "context": ["view", "edit"], "description": "What running the tool will do.", "type": "string" }, - "description": { "context": ["view", "edit"], "description": "Tool description.", "type": "string" }, - "id": { "context": ["view", "edit"], "description": "A unique identifier for the tool.", "type": "string" }, - "message": { "context": ["edit"], "description": "Tool return message.", "type": "string" }, - "name": { "context": ["view", "edit"], "description": "Tool name.", "type": "string" }, - "success": { "context": ["edit"], "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "context": [ + "edit", + "view" + ], + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Tool description.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the tool.", + "type": "string" + }, + "message": { + "context": [ + "edit" + ], + "description": "Tool return message.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tool name.", + "type": "string" + }, + "success": { + "context": [ + "edit" + ], + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "title": "system_status_tool", "type": "object" @@ -13311,45 +21536,81 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["post_tag"], + "enum": [ + "post_tag" + ], "readonly": true, "type": "string" } @@ -13360,43 +21621,112 @@ "tax": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "city": { "context": ["view", "edit"], "description": "City name.", "type": "string" }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, "class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "standard", "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "type": "string" }, "compound": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "context": ["view", "edit"], "description": "Country ISO 3166 code.", "type": "string" }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country ISO 3166 code.", + "type": "string" + }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Tax rate name.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate name.", + "type": "string" + }, "order": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "context": ["view", "edit"], "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "context": ["view", "edit"], "default": 1, "description": "Tax priority.", "type": "integer" }, - "rate": { "context": ["view", "edit"], "description": "Tax rate.", "type": "string" }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "context": [ + "edit", + "view" + ], + "default": 1, + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate.", + "type": "string" + }, "shipping": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "context": ["view", "edit"], "description": "State code.", "type": "string" } + "state": { + "context": [ + "edit", + "view" + ], + "description": "State code.", + "type": "string" + } }, "title": "tax", "type": "object" @@ -13404,9 +21734,20 @@ "tax_class": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view", "edit"], "description": "Tax class name.", "required": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax class name.", + "required": true, + "type": "string" + }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "string" @@ -13419,75 +21760,113 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "capabilities": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "All capabilities used by the taxonomy.", "readonly": true, "type": "object" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human-readable description of the taxonomy.", "readonly": true, "type": "string" }, "hierarchical": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the taxonomy should have children.", "readonly": true, "type": "boolean" }, "labels": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Human-readable labels for the taxonomy for various contexts.", "readonly": true, "type": "object" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the taxonomy.", "readonly": true, "type": "string" }, "rest_base": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "REST base route for the taxonomy.", "readonly": true, "type": "string" }, "rest_namespace": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "REST namespace route for the taxonomy.", "readonly": true, "type": "string" }, "show_cloud": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether or not the term cloud should be displayed.", "readonly": true, "type": "boolean" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the taxonomy.", "readonly": true, "type": "string" }, "types": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Types associated with the taxonomy.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "visibility": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "The visibility settings for the taxonomy.", "properties": { "public": { "description": "Whether a taxonomy is intended for use publicly either via the admin interface or by front end users.", "type": "boolean" }, - "publicly_queryable": { "description": "Whether the taxonomy is publicly queryable.", "type": "boolean" }, + "publicly_queryable": { + "description": "Whether the taxonomy is publicly queryable.", + "type": "boolean" + }, "show_admin_column": { "description": "Whether to allow automatic creation of taxonomy columns on associated post types table.", "type": "boolean" @@ -13516,32 +21895,55 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of objects (posts of any type) assigned to the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Term description.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "Term name.", "readonly": true, "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "readonly": true, + "type": "string" + }, "parent": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent term ID, if applicable.", "readonly": true, "type": "integer" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "String based identifier for the term.", "readonly": true, "type": "string" @@ -13556,8 +21958,14 @@ "author": { "description": "The theme author.", "properties": { - "raw": { "description": "The theme author's name, as found in the theme header.", "type": "string" }, - "rendered": { "description": "HTML for the theme author, transformed for display.", "type": "string" } + "raw": { + "description": "The theme author's name, as found in the theme header.", + "type": "string" + }, + "rendered": { + "description": "HTML for the theme author, transformed for display.", + "type": "string" + } }, "readonly": true, "type": "object" @@ -13582,8 +21990,14 @@ "description": { "description": "A description of the theme.", "properties": { - "raw": { "description": "The theme description, as found in the theme header.", "type": "string" }, - "rendered": { "description": "The theme description, transformed for display.", "type": "string" } + "raw": { + "description": "The theme description, as found in the theme header.", + "type": "string" + }, + "rendered": { + "description": "The theme description, transformed for display.", + "type": "string" + } }, "readonly": true, "type": "object" @@ -13596,8 +22010,14 @@ "name": { "description": "The name of the theme.", "properties": { - "raw": { "description": "The theme name, as found in the theme header.", "type": "string" }, - "rendered": { "description": "The theme name, transformed for display.", "type": "string" } + "raw": { + "description": "The theme name, as found in the theme header.", + "type": "string" + }, + "rendered": { + "description": "The theme name, transformed for display.", + "type": "string" + } }, "readonly": true, "type": "object" @@ -13620,7 +22040,10 @@ }, "status": { "description": "A named status for the theme.", - "enum": ["inactive", "active"], + "enum": [ + "active", + "inactive" + ], "type": "string" }, "stylesheet": { @@ -13639,10 +22062,15 @@ "properties": { "raw": { "description": "The theme tags, as found in the theme header.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, - "rendered": { "description": "The theme tags, transformed for display.", "type": "string" } + "rendered": { + "description": "The theme tags, transformed for display.", + "type": "string" + } }, "readonly": true, "type": "object" @@ -13658,7 +22086,11 @@ "readonly": true, "type": "string" }, - "textdomain": { "description": "The theme's text domain.", "readonly": true, "type": "string" }, + "textdomain": { + "description": "The theme's text domain.", + "readonly": true, + "type": "string" + }, "theme_supports": { "description": "Features supported by this theme.", "properties": { @@ -13687,48 +22119,142 @@ "default": false, "description": "Custom background if defined by the theme.", "properties": { - "default-attachment": { "enum": ["scroll", "fixed"], "type": "string" }, - "default-color": { "type": "string" }, - "default-image": { "format": "uri", "type": "string" }, - "default-position-x": { "enum": ["left", "center", "right"], "type": "string" }, - "default-position-y": { "enum": ["left", "center", "right"], "type": "string" }, - "default-preset": { "enum": ["default", "fill", "fit", "repeat", "custom"], "type": "string" }, - "default-repeat": { "enum": ["repeat-x", "repeat-y", "repeat", "no-repeat"], "type": "string" }, - "default-size": { "enum": ["auto", "contain", "cover"], "type": "string" } + "default-attachment": { + "enum": [ + "fixed", + "scroll" + ], + "type": "string" + }, + "default-color": { + "type": "string" + }, + "default-image": { + "format": "uri", + "type": "string" + }, + "default-position-x": { + "enum": [ + "center", + "left", + "right" + ], + "type": "string" + }, + "default-position-y": { + "enum": [ + "center", + "left", + "right" + ], + "type": "string" + }, + "default-preset": { + "enum": [ + "custom", + "default", + "fill", + "fit", + "repeat" + ], + "type": "string" + }, + "default-repeat": { + "enum": [ + "no-repeat", + "repeat", + "repeat-x", + "repeat-y" + ], + "type": "string" + }, + "default-size": { + "enum": [ + "auto", + "contain", + "cover" + ], + "type": "string" + } }, - "type": ["boolean", "object"] + "type": [ + "boolean", + "object" + ] }, "custom-header": { "additionalProperties": false, "default": false, "description": "Custom header if defined by the theme.", "properties": { - "default-image": { "format": "uri", "type": "string" }, - "default-text-color": { "type": "string" }, - "flex-height": { "type": "boolean" }, - "flex-width": { "type": "boolean" }, - "header-text": { "type": "boolean" }, - "height": { "type": "integer" }, - "random-default": { "type": "boolean" }, - "uploads": { "type": "boolean" }, - "video": { "type": "boolean" }, - "width": { "type": "integer" } + "default-image": { + "format": "uri", + "type": "string" + }, + "default-text-color": { + "type": "string" + }, + "flex-height": { + "type": "boolean" + }, + "flex-width": { + "type": "boolean" + }, + "header-text": { + "type": "boolean" + }, + "height": { + "type": "integer" + }, + "random-default": { + "type": "boolean" + }, + "uploads": { + "type": "boolean" + }, + "video": { + "type": "boolean" + }, + "width": { + "type": "integer" + } }, - "type": ["boolean", "object"] + "type": [ + "boolean", + "object" + ] }, "custom-logo": { "additionalProperties": false, "default": false, "description": "Custom logo if defined by the theme.", "properties": { - "flex-height": { "type": "boolean" }, - "flex-width": { "type": "boolean" }, - "header-text": { "items": { "type": "string" }, "type": "array" }, - "height": { "type": "integer" }, - "unlink-homepage-logo": { "type": "boolean" }, - "width": { "type": "integer" } + "flex-height": { + "type": "boolean" + }, + "flex-width": { + "type": "boolean" + }, + "header-text": { + "items": { + "type": "string" + }, + "type": "array" + }, + "height": { + "type": "integer" + }, + "unlink-homepage-logo": { + "type": "boolean" + }, + "width": { + "type": "integer" + } }, - "type": ["boolean", "object"] + "type": [ + "boolean", + "object" + ] }, "customize-selective-refresh-widgets": { "default": false, @@ -13766,13 +22292,22 @@ "items": { "additionalProperties": false, "properties": { - "color": { "type": "string" }, - "name": { "type": "string" }, - "slug": { "type": "string" } + "color": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + } }, "type": "object" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "editor-font-sizes": { "default": false, @@ -13780,13 +22315,22 @@ "items": { "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "size": { "type": "number" }, - "slug": { "type": "string" } + "name": { + "type": "string" + }, + "size": { + "type": "number" + }, + "slug": { + "type": "string" + } }, "type": "object" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "editor-gradient-presets": { "default": false, @@ -13794,13 +22338,22 @@ "items": { "additionalProperties": false, "properties": { - "gradient": { "type": "string" }, - "name": { "type": "string" }, - "slug": { "type": "string" } + "gradient": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + } }, "type": "object" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "editor-spacing-sizes": { "default": false, @@ -13808,13 +22361,22 @@ "items": { "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "size": { "type": "string" }, - "slug": { "type": "string" } + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "slug": { + "type": "string" + } }, "type": "object" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "editor-styles": { "default": false, @@ -13822,7 +22384,9 @@ "type": "boolean" }, "formats": { - "default": ["standard"], + "default": [ + "standard" + ], "description": "Post formats supported.", "items": { "enum": { @@ -13845,16 +22409,32 @@ "default": false, "description": "Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.", "items": { - "enum": ["search-form", "comment-form", "comment-list", "gallery", "caption", "script", "style"], + "enum": [ + "caption", + "comment-form", + "comment-list", + "gallery", + "script", + "search-form", + "style" + ], "type": "string" }, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "post-thumbnails": { "default": false, "description": "The post types that support thumbnails or true if all post types are supported.", - "items": { "type": "string" }, - "type": ["boolean", "array"] + "items": { + "type": "string" + }, + "type": [ + "array", + "boolean" + ] }, "responsive-embeds": { "default": false, @@ -13892,7 +22472,11 @@ "readonly": true, "type": "object" }, - "version": { "description": "The theme's current version.", "readonly": true, "type": "string" } + "version": { + "description": "The theme's current version.", + "readonly": true, + "type": "string" + } }, "title": "theme", "type": "object" @@ -13900,10 +22484,26 @@ "top_sellers_report": { "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { - "name": { "context": ["view"], "description": "Product name.", "readonly": true, "type": "string" }, - "product_id": { "context": ["view"], "description": "Product ID.", "readonly": true, "type": "integer" }, + "name": { + "context": [ + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "product_id": { + "context": [ + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + }, "quantity": { - "context": ["view"], + "context": [ + "view" + ], "description": "Total number of purchases.", "readonly": true, "type": "integer" @@ -13916,99 +22516,167 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "capabilities": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "All capabilities used by the post type.", "readonly": true, "type": "object" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human-readable description of the post type.", "readonly": true, "type": "string" }, "has_archive": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive.", "readonly": true, - "type": ["string", "boolean"] + "type": [ + "boolean", + "string" + ] }, "hierarchical": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Whether or not the post type should have children.", "readonly": true, "type": "boolean" }, "icon": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The icon for the post type.", "readonly": true, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "labels": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Human-readable labels for the post type for various contexts.", "readonly": true, "type": "object" }, "name": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post type.", "readonly": true, "type": "string" }, "rest_base": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "REST base route for the post type.", "readonly": true, "type": "string" }, "rest_namespace": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "REST route's namespace for the post type.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post type.", "readonly": true, "type": "string" }, "supports": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "All features, supported by the post type.", "readonly": true, "type": "object" }, "taxonomies": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxonomies associated with post type.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "template": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The block template associated with the post type.", "readonly": true, - "type": ["array"] + "type": [ + "array" + ] }, "template_lock": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The template_lock associated with the post type, or false if none.", - "enum": ["all", "insert", "contentOnly", false], + "enum": [ + "all", + "insert", + "contentOnly", + false + ], "readonly": true, - "type": ["string", "boolean"] + "type": [ + "boolean", + "string" + ] }, "viewable": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Whether or not the post type can be viewed.", "readonly": true, "type": "boolean" }, "visibility": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "The visibility settings for the post type.", "properties": { "show_in_nav_menus": { @@ -14031,18 +22699,32 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "message": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Theme installation message.", "readonly": true, "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Theme installation status.", "readonly": true, "type": "string" }, - "theme": { "context": ["view", "edit"], "description": "Uploaded theme.", "readonly": true, "type": "object" } + "theme": { + "context": [ + "edit", + "view" + ], + "description": "Uploaded theme.", + "readonly": true, + "type": "object" + } }, "title": "upload_theme", "type": "object" @@ -14051,23 +22733,39 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "avatar_urls": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URLs for the user.", "properties": { "24": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 24 pixels.", "format": "uri", "type": "string" }, "48": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 48 pixels.", "format": "uri", "type": "string" }, "96": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Avatar URL with image size of 96 pixels.", "format": "uri", "type": "string" @@ -14077,57 +22775,100 @@ "type": "object" }, "capabilities": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "All capabilities assigned to the user.", "readonly": true, "type": "object" }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Description of the user.", "type": "string" }, "email": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "The email address for the user.", "format": "email", "required": true, "type": "string" }, "extra_capabilities": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Any extra capabilities assigned to the user.", "readonly": true, "type": "object" }, - "first_name": { "context": ["edit"], "description": "First name for the user.", "type": "string" }, + "first_name": { + "context": [ + "edit" + ], + "description": "First name for the user.", + "type": "string" + }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the user.", "readonly": true, "type": "integer" }, - "last_name": { "context": ["edit"], "description": "Last name for the user.", "type": "string" }, + "last_name": { + "context": [ + "edit" + ], + "description": "Last name for the user.", + "type": "string" + }, "link": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Author URL of the user.", "format": "uri", "readonly": true, "type": "string" }, "locale": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Locale for the user.", - "enum": ["", "en_US", "en_GB", "fr_BE", "fr_FR"], + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], "type": "string" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", "properties": { "persisted_preferences": { "additionalProperties": true, - "context": ["edit"], + "context": [ + "edit" + ], "default": [], "description": "", "properties": { @@ -14154,11 +22895,21 @@ "type": "object" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Display name for the user.", "type": "string" }, - "nickname": { "context": ["edit"], "description": "The nickname for the user.", "type": "string" }, + "nickname": { + "context": [ + "edit" + ], + "description": "The nickname for the user.", + "type": "string" + }, "password": { "context": [], "description": "Password for the user (never included).", @@ -14166,31 +22917,47 @@ "type": "string" }, "registered_date": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Registration date for the user.", "format": "date-time", "readonly": true, "type": "string" }, "roles": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Roles assigned to the user.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array" }, "slug": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the user.", "type": "string" }, "url": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the user.", "format": "uri", "type": "string" }, "username": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Login name for the user.", "required": true, "type": "string" @@ -14203,70 +22970,127 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook was created, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook was created, as GMT.", "readonly": true, "type": "date-time" }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook was last modified, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook was last modified, as GMT.", "readonly": true, "type": "date-time" }, "delivery_url": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The URL where the webhook payload is delivered.", "format": "uri", "readonly": true, "type": "string" }, - "event": { "context": ["view", "edit"], "description": "Webhook event.", "readonly": true, "type": "string" }, + "event": { + "context": [ + "edit", + "view" + ], + "description": "Webhook event.", + "readonly": true, + "type": "string" + }, "hooks": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "WooCommerce action names associated with the webhook.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "name": { "context": ["view", "edit"], "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "A friendly name for the webhook.", + "type": "string" + }, "resource": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Webhook resource.", "readonly": true, "type": "string" }, "secret": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "active", "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "type": "string" }, - "topic": { "context": ["view", "edit"], "description": "Webhook topic.", "type": "string" } + "topic": { + "context": [ + "edit", + "view" + ], + "description": "Webhook topic.", + "type": "string" + } }, "title": "webhook", "type": "object" @@ -14275,71 +23099,106 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook delivery was logged, in the site's timezone.", "readonly": true, "type": "date-time" }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the webhook delivery was logged, as GMT.", "readonly": true, "type": "date-time" }, "duration": { - "context": ["view"], + "context": [ + "view" + ], "description": "The delivery duration, in seconds.", "readonly": true, "type": "string" }, "id": { - "context": ["view"], + "context": [ + "view" + ], "description": "Unique identifier for the resource.", "readonly": true, "type": "integer" }, - "request_body": { "context": ["view"], "description": "Request body", "readonly": true, "type": "string" }, + "request_body": { + "context": [ + "view" + ], + "description": "Request body", + "readonly": true, + "type": "string" + }, "request_headers": { - "context": ["view"], + "context": [ + "view" + ], "description": "Request headers", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "request_url": { - "context": ["view"], + "context": [ + "view" + ], "description": "The URL where the webhook was delivered.", "format": "uri", "readonly": true, "type": "string" }, "response_body": { - "context": ["view"], + "context": [ + "view" + ], "description": "The response body from the receiving server.", "readonly": true, "type": "string" }, "response_code": { - "context": ["view"], + "context": [ + "view" + ], "description": "The HTTP response code from the receiving server.", "readonly": true, "type": "string" }, "response_headers": { - "context": ["view"], + "context": [ + "view" + ], "description": "Array of the response headers from the receiving server.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "readonly": true, "type": "array" }, "response_message": { - "context": ["view"], + "context": [ + "view" + ], "description": "The HTTP response message from the receiving server.", "readonly": true, "type": "string" }, "summary": { - "context": ["view"], + "context": [ + "view" + ], "description": "A friendly summary of the response including the HTTP response code, message, and body.", "readonly": true, "type": "string" @@ -14357,32 +23216,48 @@ "type": "string" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the widget.", "type": "string" }, "id_base": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, "instance": { - "context": ["edit"], + "context": [ + "edit" + ], "default": null, "description": "Instance settings of the widget, if supported.", "properties": { "encoded": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Base64 encoded representation of the instance settings.", "type": "string" }, "hash": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Cryptographic hash of the instance settings.", "type": "string" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Unencoded instance settings, if supported.", "type": "object" } @@ -14390,19 +23265,29 @@ "type": "object" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML representation of the widget.", "readonly": true, "type": "string" }, "rendered_form": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "HTML representation of the widget admin form.", "readonly": true, "type": "string" }, "sidebar": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": "wp_inactive_widgets", "description": "The sidebar to which the widget belongs.", "required": true, @@ -14416,32 +23301,52 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "classname": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Class name", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Description of the widget.", "type": "string" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique slug identifying the widget type.", "readonly": true, "type": "string" }, "is_multi": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the widget supports multiple instances", "readonly": true, "type": "boolean" }, "name": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Human-readable name identifying the widget type.", "readonly": true, @@ -14463,11 +23368,21 @@ "description": "The category this test is grouped in.", "properties": { "color": { - "enum": ["blue", "orange", "red", "green", "purple", "gray"], + "enum": [ + "blue", + "gray", + "green", + "orange", + "purple", + "red" + ], "readonly": true, "type": "string" }, - "label": { "readonly": true, "type": "string" } + "label": { + "readonly": true, + "type": "string" + } }, "readonly": true, "type": "object" @@ -14477,14 +23392,26 @@ "readonly": true, "type": "string" }, - "label": { "description": "A label describing the test.", "readonly": true, "type": "string" }, - "status": { - "description": "The status of the test.", - "enum": ["good", "recommended", "critical"], + "label": { + "description": "A label describing the test.", "readonly": true, "type": "string" }, - "test": { "description": "The name of the test being run.", "readonly": true, "type": "string" } + "status": { + "description": "The status of the test.", + "enum": [ + "critical", + "good", + "recommended" + ], + "readonly": true, + "type": "string" + }, + "test": { + "description": "The name of the test being run.", + "readonly": true, + "type": "string" + } }, "title": "wp-site-health-test", "type": "object" @@ -14496,7 +23423,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -14504,14 +23439,30 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." }, { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", "rel": "https:/api.w.org/action-assign-wp_pattern_category", "targetSchema": { - "properties": { "wp_pattern_category": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "wp_pattern_category": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can assign terms in the wp_pattern_category taxonomy." @@ -14520,7 +23471,14 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", "rel": "https:/api.w.org/action-create-wp_pattern_category", "targetSchema": { - "properties": { "wp_pattern_category": { "items": { "type": "integer" }, "type": "array" } }, + "properties": { + "wp_pattern_category": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, "type": "object" }, "title": "The current user can create terms in the wp_pattern_category taxonomy." @@ -14528,23 +23486,35 @@ ], "properties": { "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the post, as it exists in the database.", "type": "string" } @@ -14552,34 +23522,61 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -14588,17 +23585,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -14608,87 +23613,130 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", "properties": { - "footnotes": { "default": "", "description": "", "type": "string" }, + "footnotes": { + "default": "", + "description": "", + "type": "string" + }, "wp_pattern_sync_status": { "default": "", "description": "", - "enum": ["partial", "unsynced"], + "enum": [ + "partial", + "unsynced" + ], "type": "string" } }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Title for the object, as it exists in the database.", "type": "string" } @@ -14696,15 +23744,24 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" }, "wp_pattern_category": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -14715,28 +23772,44 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the post, as it exists in the database.", "type": "string" } @@ -14744,34 +23817,55 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "excerpt": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -14780,17 +23874,25 @@ "type": "object" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -14800,59 +23902,96 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta fields.", "properties": { - "footnotes": { "default": "", "description": "", "type": "string" }, + "footnotes": { + "default": "", + "description": "", + "type": "string" + }, "wp_pattern_sync_status": { "default": "", "description": "", - "enum": ["partial", "unsynced"], + "enum": [ + "partial", + "unsynced" + ], "type": "string" } }, "type": "object" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Title for the object, as it exists in the database.", "type": "string" } @@ -14868,59 +24007,132 @@ "properties": { "font_face_settings": { "additionalProperties": false, - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "font-face declaration in theme.json format.", "properties": { - "ascentOverride": { "description": "CSS ascent-override value.", "type": "string" }, - "descentOverride": { "description": "CSS descent-override value.", "type": "string" }, + "ascentOverride": { + "description": "CSS ascent-override value.", + "type": "string" + }, + "descentOverride": { + "description": "CSS descent-override value.", + "type": "string" + }, "fontDisplay": { "default": "fallback", "description": "CSS font-display value.", - "enum": ["auto", "block", "fallback", "swap", "optional"], + "enum": [ + "auto", + "block", + "fallback", + "optional", + "swap" + ], + "type": "string" + }, + "fontFamily": { + "default": "", + "description": "CSS font-family value.", + "type": "string" + }, + "fontFeatureSettings": { + "description": "CSS font-feature-settings value.", + "type": "string" + }, + "fontStretch": { + "description": "CSS font-stretch value.", + "type": "string" + }, + "fontStyle": { + "default": "normal", + "description": "CSS font-style value.", + "type": "string" + }, + "fontVariant": { + "description": "CSS font-variant value.", + "type": "string" + }, + "fontVariationSettings": { + "description": "CSS font-variation-settings value.", "type": "string" }, - "fontFamily": { "default": "", "description": "CSS font-family value.", "type": "string" }, - "fontFeatureSettings": { "description": "CSS font-feature-settings value.", "type": "string" }, - "fontStretch": { "description": "CSS font-stretch value.", "type": "string" }, - "fontStyle": { "default": "normal", "description": "CSS font-style value.", "type": "string" }, - "fontVariant": { "description": "CSS font-variant value.", "type": "string" }, - "fontVariationSettings": { "description": "CSS font-variation-settings value.", "type": "string" }, "fontWeight": { "default": "400", "description": "List of available font weights, separated by a space.", - "type": ["string", "integer"] + "type": [ + "integer", + "string" + ] + }, + "lineGapOverride": { + "description": "CSS line-gap-override value.", + "type": "string" }, - "lineGapOverride": { "description": "CSS line-gap-override value.", "type": "string" }, "preview": { "default": "", "description": "URL to a preview image of the font face.", "format": "uri", "type": "string" }, - "sizeAdjust": { "description": "CSS size-adjust value.", "type": "string" }, + "sizeAdjust": { + "description": "CSS size-adjust value.", + "type": "string" + }, "src": { - "anyOf": [{ "type": "string" }, { "items": { "type": "string" }, "type": "array" }], + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], "default": [], "description": "Paths or URLs to the font files." }, - "unicodeRange": { "description": "CSS unicode-range value.", "type": "string" } + "unicodeRange": { + "description": "CSS unicode-range value.", + "type": "string" + } }, - "required": ["fontFamily", "src"], + "required": [ + "fontFamily", + "src" + ], "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent font family of the font face.", "type": "integer" }, "theme_json_version": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 3, "description": "Version of the theme.json schema used for the typography settings.", "maximum": 3, @@ -14935,37 +24147,68 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "font_faces": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The IDs of the child font faces in the font family.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" }, "font_family_settings": { "additionalProperties": false, - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "font-face definition in theme.json format.", "properties": { - "fontFamily": { "description": "CSS font-family value.", "type": "string" }, - "name": { "description": "Name of the font family preset, translatable.", "type": "string" }, + "fontFamily": { + "description": "CSS font-family value.", + "type": "string" + }, + "name": { + "description": "Name of the font family preset, translatable.", + "type": "string" + }, "preview": { "default": "", "description": "URL to a preview image of the font family.", "format": "uri", "type": "string" }, - "slug": { "description": "Kebab-case unique identifier for the font family preset.", "type": "string" } + "slug": { + "description": "Kebab-case unique identifier for the font family preset.", + "type": "string" + } }, - "required": ["name", "slug", "fontFamily"], + "required": [ + "fontFamily", + "name", + "slug" + ], "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "theme_json_version": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "default": 3, "description": "Version of the theme.json schema used for the typography settings.", "maximum": 3, @@ -14980,31 +24223,68 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of global styles config.", "readonly": true, "type": "string" }, - "settings": { "context": ["view", "edit"], "description": "Global settings.", "type": ["object"] }, - "styles": { "context": ["view", "edit"], "description": "Global styles.", "type": ["object"] }, + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "context": [ + "edit", + "view" + ], + "description": "Global styles.", + "type": [ + "object" + ] + }, "title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Title of the global styles variation.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the global styles variation, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] } }, "title": "wp_global_styles", @@ -15014,47 +24294,90 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of global styles config.", "readonly": true, "type": "string" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, - "settings": { "context": ["view", "edit"], "description": "Global settings.", "type": ["object"] }, - "styles": { "context": ["view", "edit"], "description": "Global styles.", "type": ["object"] } + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "context": [ + "edit", + "view" + ], + "description": "Global styles.", + "type": [ + "object" + ] + } }, "title": "wp_global_styles-revision", "type": "object" @@ -15066,7 +24389,15 @@ "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", "rel": "https:/api.w.org/action-publish", "targetSchema": { - "properties": { "status": { "enum": ["publish", "future"], "type": "string" } }, + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, "type": "object" }, "title": "The current user can publish this post." @@ -15074,34 +24405,61 @@ { "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", "rel": "https:/api.w.org/action-unfiltered-html", - "targetSchema": { "properties": { "content": { "raw": { "type": "string" } } }, "type": "object" }, + "targetSchema": { + "properties": { + "content": { + "raw": { + "type": "string" + } + } + }, + "type": "object" + }, "title": "The current user can post unfiltered HTML markup and JavaScript." } ], "properties": { "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -15110,29 +24468,50 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the post was published, in the site's time zone.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was published, as GMT.", "format": "date-time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -15142,78 +24521,116 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the post.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL to the post.", "format": "uri", "readonly": true, "type": "string" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the post was last modified, as GMT.", "format": "date-time", "readonly": true, "type": "string" }, "password": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "A password to protect access to the content and excerpt.", "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "template": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The theme file to use to display the post.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -15222,7 +24639,11 @@ "type": "object" }, "type": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type of post.", "readonly": true, "type": "string" @@ -15235,33 +24656,55 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the revision.", "type": "integer" }, "content": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -15270,29 +24713,44 @@ "type": "object" }, "date": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The date the revision was published, in the site's time zone.", "format": "date-time", "type": "string" }, "date_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was published, as GMT.", "format": "date-time", "type": "string" }, "guid": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The globally unique identifier for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "GUID for the post, as it exists in the database.", "readonly": true, "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "GUID for the post, transformed for display.", "readonly": true, "type": "string" @@ -15302,51 +24760,90 @@ "type": "object" }, "id": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the revision.", "type": "integer" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, in the site's time zone.", "format": "date-time", "type": "string" }, "modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the revision was last modified, as GMT.", "format": "date-time", "type": "string" }, "parent": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the parent of the revision.", "type": "integer" }, "preview_link": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Preview link for the post.", "format": "uri", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the revision unique to its type.", "type": "string" }, "title": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the post.", "properties": { "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -15362,45 +24859,81 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "count": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Number of published posts for the term.", "readonly": true, "type": "integer" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description of the term.", "type": "string" }, "id": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the term.", "readonly": true, "type": "integer" }, "link": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "URL of the term.", "format": "uri", "readonly": true, "type": "string" }, - "meta": { "context": ["view", "edit"], "description": "Meta fields.", "properties": [], "type": "object" }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, "name": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { - "context": ["view", "embed", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Type attribution for the term.", - "enum": ["wp_pattern_category"], + "enum": [ + "wp_pattern_category" + ], "readonly": true, "type": "string" } @@ -15412,81 +24945,137 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the template.", "type": "integer" }, "author_text": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Human readable text for the author.", "readonly": true, "type": "string" }, "content": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Description of template.", "type": "string" }, "has_theme_file": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Theme file exists.", "readonly": true, "type": "bool" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of template.", "readonly": true, "type": "string" }, "is_custom": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether a template is a custom template.", "readonly": true, "type": "bool" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the template was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "origin": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Source of a customised template", "readonly": true, "type": "string" }, "original_source": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "From where the template originally comes, eg 'theme'", - "enum": ["theme", "plugin", "site", "user"], + "enum": [ + "plugin", + "site", + "theme", + "user" + ], "readonly": true, "type": "string" }, "slug": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", @@ -15494,59 +25083,98 @@ "type": "string" }, "source": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Source of template", "readonly": true, "type": "string" }, "status": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "publish", "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "theme": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Theme identifier for the template.", "type": "string" }, "title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of template.", + "type": "string" }, - "type": { "context": ["embed", "view", "edit"], "description": "Type of template.", "type": "string" }, "wp_id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Post ID.", "readonly": true, "type": "integer" @@ -15559,80 +25187,136 @@ "$schema": "http:/json-schema.org/draft-04/schema#", "properties": { "area": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, "author": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "The ID for the author of the template.", "type": "integer" }, "author_text": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Human readable text for the author.", "readonly": true, "type": "string" }, "content": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Description of template.", "type": "string" }, "has_theme_file": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Theme file exists.", "readonly": true, "type": "bool" }, "id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "ID of template.", "readonly": true, "type": "string" }, "modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the template was last modified, in the site's time zone.", "format": "date-time", "readonly": true, "type": "string" }, "origin": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Source of a customised template", "readonly": true, "type": "string" }, "original_source": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "From where the template originally comes, eg 'theme'", - "enum": ["theme", "plugin", "site", "user"], + "enum": [ + "plugin", + "site", + "theme", + "user" + ], "readonly": true, "type": "string" }, "slug": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", @@ -15640,59 +25324,98 @@ "type": "string" }, "source": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Source of template", "readonly": true, "type": "string" }, "status": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "publish", "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "type": "string" }, "theme": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Theme identifier for the template.", "type": "string" }, "title": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "default": "", "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of template.", + "type": "string" }, - "type": { "context": ["embed", "view", "edit"], "description": "Type of template.", "type": "string" }, "wp_id": { - "context": ["embed", "view", "edit"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Post ID.", "readonly": true, "type": "integer" @@ -15704,7 +25427,11 @@ } }, "info": { - "contact": { "email": "contact@gcch.fr", "name": "Haiku Atelier", "url": "https:/haikuatelier.fr.ddev.site" }, + "contact": { + "email": "contact@gcch.fr", + "name": "Haiku Atelier", + "url": "https:/haikuatelier.fr.ddev.site" + }, "description": "", "title": "Haiku Atelier API", "version": "6.6.1" @@ -15714,14 +25441,46 @@ "/carbon-fields/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/carbon-fields/v1/association": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/carbon-fields/v1/association/options": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/carbon-fields/v1/association": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/carbon-fields/v1/association/options": { "get": { "responses": { "200": { "description": "OK" } } } }, "/carbon-fields/v1/attachment": { "get": { "parameters": [ @@ -15740,7 +25499,11 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/block-renderer": { @@ -15750,73 +25513,182 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content of the block.", "required": true, "type": "string" }, - "name": { "description": "The name of the block.", "required": true, "type": "string" }, - "post_id": { "description": "ID of the post context.", "type": "integer" } + "content": { + "description": "The content of the block.", + "required": true, + "type": "string" + }, + "name": { + "description": "The name of the block.", + "required": true, + "type": "string" + }, + "post_id": { + "description": "ID of the post context.", + "type": "integer" + } }, - "required": ["name", "content"], + "required": [ + "content", + "name" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/comments/{id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/options": { - "get": { "responses": { "200": { "description": "OK" } } }, - "post": { "responses": { "200": { "description": "OK" } } } + "get": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/carbon-fields/v1/posts/{id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/terms/{id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/carbon-fields/v1/users/{id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4/connection": { - "get": { "responses": { "200": { "description": "OK" } } }, + "get": { + "responses": { + "200": { + "description": "OK" + } + } + }, "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "isActive": { "description": "Set to false will trigger the site to disconnect.", "required": true } + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true + } }, - "required": ["isActive"], + "required": [ + "isActive" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -15824,15 +25696,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "isActive": { "description": "Set to false will trigger the site to disconnect.", "required": true } + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true + } }, - "required": ["isActive"], + "required": [ + "isActive" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -15840,15 +25721,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "isActive": { "description": "Set to false will trigger the site to disconnect.", "required": true } + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true + } }, - "required": ["isActive"], + "required": [ + "isActive" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4/connection/authorize_url": { @@ -15862,59 +25752,133 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/connection/data": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/jetpack/v4/connection/data": { "get": { "responses": { "200": { "description": "OK" } } } }, "/jetpack/v4/connection/owner": { "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "owner": { "description": "New owner", "required": true, "type": "integer" } }, - "required": ["owner"], + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "owner": { "description": "New owner", "required": true, "type": "integer" } }, - "required": ["owner"], + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "owner": { "description": "New owner", "required": true, "type": "integer" } }, - "required": ["owner"], + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/connection/plugins": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/jetpack/v4/connection/plugins": { "get": { "responses": { "200": { "description": "OK" } } } }, "/jetpack/v4/connection/reconnect": { - "patch": { "responses": { "200": { "description": "OK" } } }, - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } } + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/jetpack/v4/connection/register": { "patch": { @@ -15935,15 +25899,25 @@ "description": "URI of the admin page where the user should be redirected after connection flow", "type": "string" }, - "registration_nonce": { "description": "The registration nonce", "required": true, "type": "string" } + "registration_nonce": { + "description": "The registration nonce", + "required": true, + "type": "string" + } }, - "required": ["registration_nonce"], + "required": [ + "registration_nonce" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -15963,15 +25937,25 @@ "description": "URI of the admin page where the user should be redirected after connection flow", "type": "string" }, - "registration_nonce": { "description": "The registration nonce", "required": true, "type": "string" } + "registration_nonce": { + "description": "The registration nonce", + "required": true, + "type": "string" + } }, - "required": ["registration_nonce"], + "required": [ + "registration_nonce" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -15991,21 +25975,49 @@ "description": "URI of the admin page where the user should be redirected after connection flow", "type": "string" }, - "registration_nonce": { "description": "The registration nonce", "required": true, "type": "string" } + "registration_nonce": { + "description": "The registration nonce", + "required": true, + "type": "string" + } }, - "required": ["registration_nonce"], + "required": [ + "registration_nonce" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4/remote_authorize": { - "patch": { "responses": { "200": { "description": "OK" } } }, - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } } + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/jetpack/v4/user-token": { "patch": { @@ -16014,16 +26026,29 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "is_connection_owner": { "description": "Is connection owner", "type": "boolean" }, - "user_token": { "description": "New user token", "required": true, "type": "string" } + "is_connection_owner": { + "description": "Is connection owner", + "type": "boolean" + }, + "user_token": { + "description": "New user token", + "required": true, + "type": "string" + } }, - "required": ["user_token"], + "required": [ + "user_token" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -16031,16 +26056,29 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "is_connection_owner": { "description": "Is connection owner", "type": "boolean" }, - "user_token": { "description": "New user token", "required": true, "type": "string" } + "is_connection_owner": { + "description": "Is connection owner", + "type": "boolean" + }, + "user_token": { + "description": "New user token", + "required": true, + "type": "string" + } }, - "required": ["user_token"], + "required": [ + "user_token" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -16048,22 +26086,53 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "is_connection_owner": { "description": "Is connection owner", "type": "boolean" }, - "user_token": { "description": "New user token", "required": true, "type": "string" } + "is_connection_owner": { + "description": "Is connection owner", + "type": "boolean" + }, + "user_token": { + "description": "New user token", + "required": true, + "type": "string" + } }, - "required": ["user_token"], + "required": [ + "user_token" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/jetpack/v4/verify_registration": { - "patch": { "responses": { "200": { "description": "OK" } } }, - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } } + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/jetpack/v4/verify_xmlrpc_error": { "post": { @@ -16071,30 +26140,63 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "nonce": { "required": true, "type": "string" } }, - "required": ["nonce"], + "properties": { + "nonce": { + "required": true, + "type": "string" + } + }, + "required": [ + "nonce" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin/experiments/assignment": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16104,33 +26206,76 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } } }, "/wc-admin/launch-your-store/initialize-coming-soon": { - "post": { "responses": { "200": { "description": "OK" } } } + "post": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/launch-your-store/survey-completed": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } }, - "/wc-admin/launch-your-store/survey-completed": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wc-admin/launch-your-store/update-survey-status": { "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } + "schema": { + "properties": { + "status": { + "type": "string" + } + }, + "type": "object" + } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin/launch-your-store/woopayments/test-orders": { - "delete": { "responses": { "200": { "description": "OK" } } } + "delete": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/wc-admin/launch-your-store/woopayments/test-orders/count": { - "get": { "responses": { "200": { "description": "OK" } } } + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } }, "/wc-admin/marketing/campaign-types": { "get": { @@ -16140,27 +26285,40 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/marketing_campaign_type" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_campaign_type" + } + } }, "description": "OK" } @@ -16175,26 +26333,41 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_campaign" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_campaign" + } + } + }, "description": "OK" } } @@ -16204,7 +26377,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_channel" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_channel" + } + } + }, "description": "OK" } } @@ -16212,10 +26391,24 @@ }, "/wc-admin/marketing/knowledge-base": { "get": { - "parameters": [{ "description": "", "in": "query", "name": "category", "required": false, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "query", + "name": "category", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16227,8 +26420,15 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "plugin": { "required": true, "type": "string" } }, - "required": ["plugin"], + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], "type": "object" } } @@ -16236,7 +26436,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16246,8 +26452,15 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "plugin": { "required": true, "type": "string" } }, - "required": ["plugin"], + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], "type": "object" } } @@ -16255,7 +26468,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16265,8 +26484,15 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "plugin": { "required": true, "type": "string" } }, - "required": ["plugin"], + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], "type": "object" } } @@ -16274,7 +26500,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16284,7 +26516,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16298,13 +26536,22 @@ "in": "query", "name": "category", "required": true, - "schema": { "enum": ["channels", "extensions"] } + "schema": { + "enum": [ + "channels", + "extensions" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/marketing_recommendation" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_recommendation" + } + } }, "description": "OK" } @@ -16319,13 +26566,28 @@ "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, - { "description": "", "in": "query", "name": "category", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "category", + "required": false, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16335,7 +26597,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16345,7 +26613,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16356,13 +26630,29 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "item_id": { "required": true } }, "required": ["item_id"], "type": "object" } + "schema": { + "properties": { + "item_id": { + "required": true + } + }, + "required": [ + "item_id" + ], + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16370,7 +26660,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16379,24 +26675,54 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "item_id": { "required": true } }, "required": ["item_id"], "type": "object" } + "schema": { + "properties": { + "item_id": { + "required": true + } + }, + "required": [ + "item_id" + ], + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/notice/dismiss": { + "post": { + "responses": { + "200": { "description": "OK" } } } }, - "/wc-admin/notice/dismiss": { "post": { "responses": { "200": { "description": "OK" } } } }, "/wc-admin/onboarding/free-extensions": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16407,7 +26733,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Install and Activate Schema" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install and Activate Schema" + } + } }, "description": "OK" } @@ -16421,9 +26751,15 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "plugins": { "description": "A list of plugins to install", "required": true, "type": "array" } + "plugins": { + "description": "A list of plugins to install", + "required": true, + "type": "array" + } }, - "required": ["plugins"], + "required": [ + "plugins" + ], "type": "object" } } @@ -16431,7 +26767,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Install Async Schema" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install Async Schema" + } + } + }, "description": "OK" } } @@ -16455,15 +26797,33 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin/onboarding/plugins/scheduled-installs/{job_id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "job_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Install Async Schema" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install Async Schema" + } + } + }, "description": "OK" } } @@ -16473,7 +26833,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16483,7 +26849,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16493,7 +26865,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16504,13 +26882,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "business_extensions": { "description": "Extra business extensions to install.", "type": "array" }, - "completed": { "description": "Whether or not the profile was completed.", "type": "boolean" }, + "business_extensions": { + "description": "Extra business extensions to install.", + "type": "array" + }, + "completed": { + "description": "Whether or not the profile was completed.", + "type": "boolean" + }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "industry": { "description": "Industry.", "type": "array" }, + "industry": { + "description": "Industry.", + "type": "array" + }, "is_agree_marketing": { "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "type": "boolean" @@ -16523,23 +26910,50 @@ "description": "Whether or not this store country is set via onboarding profiler.", "type": "boolean" }, - "number_employees": { "description": "Number of employees of the store.", "type": "string" }, - "other_platform": { "description": "Name of other platform used to sell.", "type": "string" }, + "number_employees": { + "description": "Number of employees of the store.", + "type": "string" + }, + "other_platform": { + "description": "Name of other platform used to sell.", + "type": "string" + }, "other_platform_name": { "description": "Name of other platform used to sell (not listed).", "type": "string" }, - "product_count": { "description": "Number of products to be added.", "type": "string" }, - "product_types": { "description": "Types of products sold.", "type": "array" }, - "revenue": { "description": "Current annual revenue of the store.", "type": "string" }, - "selling_venues": { "description": "Other places the store is selling products.", "type": "string" }, + "product_count": { + "description": "Number of products to be added.", + "type": "string" + }, + "product_types": { + "description": "Types of products sold.", + "type": "array" + }, + "revenue": { + "description": "Current annual revenue of the store.", + "type": "string" + }, + "selling_venues": { + "description": "Other places the store is selling products.", + "type": "string" + }, "setup_client": { "description": "Whether or not this store was setup for a client.", "type": "boolean" }, - "skipped": { "description": "Whether or not the profile was skipped.", "type": "boolean" }, - "store_email": { "description": "Store email address.", "type": "string" }, - "theme": { "description": "Selected store theme.", "type": "string" }, + "skipped": { + "description": "Whether or not the profile was skipped.", + "type": "boolean" + }, + "store_email": { + "description": "Store email address.", + "type": "string" + }, + "theme": { + "description": "Selected store theme.", + "type": "string" + }, "wccom_connected": { "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", "type": "boolean" @@ -16552,7 +26966,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16563,13 +26983,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "business_extensions": { "description": "Extra business extensions to install.", "type": "array" }, - "completed": { "description": "Whether or not the profile was completed.", "type": "boolean" }, + "business_extensions": { + "description": "Extra business extensions to install.", + "type": "array" + }, + "completed": { + "description": "Whether or not the profile was completed.", + "type": "boolean" + }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "industry": { "description": "Industry.", "type": "array" }, + "industry": { + "description": "Industry.", + "type": "array" + }, "is_agree_marketing": { "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "type": "boolean" @@ -16582,23 +27011,50 @@ "description": "Whether or not this store country is set via onboarding profiler.", "type": "boolean" }, - "number_employees": { "description": "Number of employees of the store.", "type": "string" }, - "other_platform": { "description": "Name of other platform used to sell.", "type": "string" }, + "number_employees": { + "description": "Number of employees of the store.", + "type": "string" + }, + "other_platform": { + "description": "Name of other platform used to sell.", + "type": "string" + }, "other_platform_name": { "description": "Name of other platform used to sell (not listed).", "type": "string" }, - "product_count": { "description": "Number of products to be added.", "type": "string" }, - "product_types": { "description": "Types of products sold.", "type": "array" }, - "revenue": { "description": "Current annual revenue of the store.", "type": "string" }, - "selling_venues": { "description": "Other places the store is selling products.", "type": "string" }, + "product_count": { + "description": "Number of products to be added.", + "type": "string" + }, + "product_types": { + "description": "Types of products sold.", + "type": "array" + }, + "revenue": { + "description": "Current annual revenue of the store.", + "type": "string" + }, + "selling_venues": { + "description": "Other places the store is selling products.", + "type": "string" + }, "setup_client": { "description": "Whether or not this store was setup for a client.", "type": "boolean" }, - "skipped": { "description": "Whether or not the profile was skipped.", "type": "boolean" }, - "store_email": { "description": "Store email address.", "type": "string" }, - "theme": { "description": "Selected store theme.", "type": "string" }, + "skipped": { + "description": "Whether or not the profile was skipped.", + "type": "boolean" + }, + "store_email": { + "description": "Store email address.", + "type": "string" + }, + "theme": { + "description": "Selected store theme.", + "type": "string" + }, "wccom_connected": { "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", "type": "boolean" @@ -16611,7 +27067,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16622,13 +27084,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "business_extensions": { "description": "Extra business extensions to install.", "type": "array" }, - "completed": { "description": "Whether or not the profile was completed.", "type": "boolean" }, + "business_extensions": { + "description": "Extra business extensions to install.", + "type": "array" + }, + "completed": { + "description": "Whether or not the profile was completed.", + "type": "boolean" + }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "industry": { "description": "Industry.", "type": "array" }, + "industry": { + "description": "Industry.", + "type": "array" + }, "is_agree_marketing": { "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "type": "boolean" @@ -16641,23 +27112,50 @@ "description": "Whether or not this store country is set via onboarding profiler.", "type": "boolean" }, - "number_employees": { "description": "Number of employees of the store.", "type": "string" }, - "other_platform": { "description": "Name of other platform used to sell.", "type": "string" }, + "number_employees": { + "description": "Number of employees of the store.", + "type": "string" + }, + "other_platform": { + "description": "Name of other platform used to sell.", + "type": "string" + }, "other_platform_name": { "description": "Name of other platform used to sell (not listed).", "type": "string" }, - "product_count": { "description": "Number of products to be added.", "type": "string" }, - "product_types": { "description": "Types of products sold.", "type": "array" }, - "revenue": { "description": "Current annual revenue of the store.", "type": "string" }, - "selling_venues": { "description": "Other places the store is selling products.", "type": "string" }, + "product_count": { + "description": "Number of products to be added.", + "type": "string" + }, + "product_types": { + "description": "Types of products sold.", + "type": "array" + }, + "revenue": { + "description": "Current annual revenue of the store.", + "type": "string" + }, + "selling_venues": { + "description": "Other places the store is selling products.", + "type": "string" + }, "setup_client": { "description": "Whether or not this store was setup for a client.", "type": "boolean" }, - "skipped": { "description": "Whether or not the profile was skipped.", "type": "boolean" }, - "store_email": { "description": "Store email address.", "type": "string" }, - "theme": { "description": "Selected store theme.", "type": "string" }, + "skipped": { + "description": "Whether or not the profile was skipped.", + "type": "boolean" + }, + "store_email": { + "description": "Store email address.", + "type": "string" + }, + "theme": { + "description": "Selected store theme.", + "type": "string" + }, "wccom_connected": { "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", "type": "boolean" @@ -16670,7 +27168,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16680,7 +27184,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, "description": "OK" } } @@ -16694,12 +27204,27 @@ "in": "query", "name": "ids", "required": false, - "schema": { "items": { "enum": ["setup", "extended", "secret_tasklist"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "extended", + "secret_tasklist", + "setup" + ], + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16726,7 +27251,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16736,7 +27267,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16749,9 +27286,15 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "template_name": { "description": "Product template name.", "required": true, "type": "string" } + "template_name": { + "description": "Product template name.", + "required": true, + "type": "string" + } }, - "required": ["template_name"], + "required": [ + "template_name" + ], "type": "object" } } @@ -16759,7 +27302,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16769,7 +27318,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16777,28 +27332,70 @@ }, "/wc-admin/onboarding/tasks/{id}/action": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16806,28 +27403,70 @@ }, "/wc-admin/onboarding/tasks/{id}/dismiss": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16835,28 +27474,70 @@ }, "/wc-admin/onboarding/tasks/{id}/hide": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16864,14 +27545,28 @@ }, "/wc-admin/onboarding/tasks/{id}/snooze": { "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "duration": { "description": "Time period to snooze the task.", "type": "string" }, - "task_list_id": { "description": "Optional parameter to query specific task list.", "type": "string" } + "duration": { + "description": "Time period to snooze the task.", + "type": "string" + }, + "task_list_id": { + "description": "Optional parameter to query specific task list.", + "type": "string" + } }, "type": "object" } @@ -16880,7 +27575,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16888,28 +27589,70 @@ }, "/wc-admin/onboarding/tasks/{id}/undo_dismiss": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16917,28 +27660,70 @@ }, "/wc-admin/onboarding/tasks/{id}/undo_snooze": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16946,28 +27731,70 @@ }, "/wc-admin/onboarding/tasks/{id}/unhide": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -16977,7 +27804,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -16985,7 +27818,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -16993,7 +27832,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -17003,7 +27848,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -17011,7 +27862,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -17019,7 +27876,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, "description": "OK" } } @@ -17040,17 +27903,35 @@ "in": "query", "name": "currency", "required": false, - "schema": { "enum": ["USD", "AUD", "CAD", "EUR", "GBP"] } + "schema": { + "enum": [ + "AUD", + "CAD", + "EUR", + "GBP", + "USD" + ] + } } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-admin/options": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, "description": "OK" } } @@ -17058,7 +27939,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, "description": "OK" } } @@ -17066,7 +27953,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, "description": "OK" } } @@ -17074,7 +27967,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, "description": "OK" } } @@ -17094,7 +27993,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/payment-gateway-suggestions" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment-gateway-suggestions" + } + } }, "description": "OK" } @@ -17106,7 +28009,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/payment-gateway-suggestions" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment-gateway-suggestions" + } + } }, "description": "OK" } @@ -17117,7 +28024,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17125,7 +28038,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17133,7 +28052,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17143,7 +28068,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17151,10 +28082,24 @@ }, "/wc-admin/plugins/activate/status/{job_id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "job_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17164,7 +28109,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17174,7 +28125,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17184,7 +28141,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17192,7 +28155,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17200,7 +28169,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17210,7 +28185,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17218,7 +28199,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17226,7 +28213,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17236,7 +28229,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17246,7 +28245,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17254,7 +28259,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17262,7 +28273,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17272,7 +28289,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17280,10 +28303,24 @@ }, "/wc-admin/plugins/install/status/{job_id}": { "get": { - "parameters": [{ "description": "", "in": "path", "name": "job_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17293,7 +28330,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17303,7 +28346,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, "description": "OK" } } @@ -17323,7 +28372,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping-partner-suggestions" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping-partner-suggestions" + } + } }, "description": "OK" } @@ -17341,7 +28394,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "pluginzip": { "description": "A zip file of the theme to be uploaded.", "type": "file" } + "pluginzip": { + "description": "A zip file of the theme to be uploaded.", + "type": "file" + } }, "type": "object" } @@ -17350,7 +28406,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, "description": "OK" } } @@ -17365,7 +28427,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "pluginzip": { "description": "A zip file of the theme to be uploaded.", "type": "file" } + "pluginzip": { + "description": "A zip file of the theme to be uploaded.", + "type": "file" + } }, "type": "object" } @@ -17374,7 +28439,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, "description": "OK" } } @@ -17389,7 +28460,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "pluginzip": { "description": "A zip file of the theme to be uploaded.", "type": "file" } + "pluginzip": { + "description": "A zip file of the theme to be uploaded.", + "type": "file" + } }, "type": "object" } @@ -17398,7 +28472,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, "description": "OK" } } @@ -17407,10 +28487,26 @@ "/wc-analytics": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-analytics/admin/notes": { @@ -17421,35 +28517,58 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["note_id", "date", "type", "title", "status"] } + "schema": { + "enum": [ + "date", + "note_id", + "status", + "title", + "type" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Type of note.", @@ -17458,7 +28577,15 @@ "required": false, "schema": { "items": { - "enum": ["error", "warning", "update", "info", "marketing", "survey", "email"], + "enum": [ + "email", + "error", + "info", + "marketing", + "survey", + "update", + "warning" + ], "type": "string" } } @@ -17469,7 +28596,16 @@ "name": "status", "required": false, "schema": { - "items": { "enum": ["pending", "actioned", "unactioned", "snoozed", "sent"], "type": "string" } + "items": { + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], + "type": "string" + } } }, { @@ -17477,12 +28613,22 @@ "in": "query", "name": "source", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17494,7 +28640,12 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "status": { "description": "Status of note.", "type": "array" } }, + "properties": { + "status": { + "description": "Status of note.", + "type": "array" + } + }, "type": "object" } } @@ -17502,7 +28653,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17510,10 +28667,24 @@ }, "/wc-analytics/admin/notes/delete/{id}": { "delete": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17521,28 +28692,70 @@ }, "/wc-analytics/admin/notes/experimental-activate-promo/{promo_note_name}": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "promo_note_name", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "promo_note_name", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "promo_note_name", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17551,12 +28764,30 @@ "/wc-analytics/admin/notes/tracker/{note_id}/user/{user_id}": { "get": { "parameters": [ - { "description": "", "in": "path", "name": "note_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17566,7 +28797,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17574,7 +28811,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17582,7 +28825,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17591,44 +28840,92 @@ "/wc-analytics/admin/notes/{id}": { "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17637,7 +28934,13 @@ "/wc-analytics/admin/notes/{note_id}/action/{action_id}": { "patch": { "parameters": [ - { "description": "Unique ID for the Note.", "in": "path", "name": "note_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the Note.", + "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the Note Action.", "in": "path", @@ -17648,14 +28951,26 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the Note.", "in": "path", "name": "note_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the Note.", + "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the Note Action.", "in": "path", @@ -17666,14 +28981,26 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the Note.", "in": "path", "name": "note_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the Note.", + "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the Note Action.", "in": "path", @@ -17684,7 +29011,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, "description": "OK" } } @@ -17698,21 +29031,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to coupons with codes matching a given string.", @@ -17726,28 +29069,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -17761,14 +29112,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -17782,14 +29141,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to resources with a specific code.", @@ -17801,7 +29174,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -17816,16 +29195,29 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "required": true, "type": "string" }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -17862,7 +29254,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -17871,7 +29266,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -17885,7 +29283,9 @@ "type": "integer" } }, - "required": ["code"], + "required": [ + "code" + ], "type": "object" } } @@ -17893,7 +29293,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -17910,16 +29316,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -17956,7 +29374,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -17965,7 +29386,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -17986,7 +29410,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -18001,16 +29431,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18047,7 +29489,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18056,7 +29501,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18077,7 +29525,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -18092,16 +29546,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18138,7 +29604,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18147,7 +29616,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18168,7 +29640,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -18190,7 +29668,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -18199,7 +29680,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18218,12 +29705,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18247,16 +29745,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18293,7 +29803,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18302,7 +29815,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18323,7 +29839,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18347,16 +29869,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18393,7 +29927,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18402,7 +29939,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18423,7 +29963,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18447,16 +29993,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -18493,7 +30051,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -18502,7 +30063,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -18523,7 +30087,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -18537,42 +30107,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -18581,17 +30170,17 @@ "required": false, "schema": { "enum": [ - "username", - "name", - "country", + "avg_order_value", "city", - "state", - "postcode", - "date_registered", + "country", "date_last_active", + "date_registered", + "name", "orders_count", + "postcode", + "state", "total_spend", - "avg_order_value" + "username" ] } }, @@ -18607,21 +30196,30 @@ "in": "query", "name": "registered_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", @@ -18635,7 +30233,14 @@ "in": "query", "name": "searchby", "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } }, { "description": "Limit response to objects with specific names.", @@ -18698,28 +30303,40 @@ "in": "query", "name": "last_active_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_active_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "last_active_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "registered_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects with an order count greater than or equal to given integer.", @@ -18740,7 +30357,11 @@ "in": "query", "name": "orders_count_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with a total order spend greater than or equal to given number.", @@ -18761,7 +30382,11 @@ "in": "query", "name": "total_spend_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with an average order spend greater than or equal to given number.", @@ -18782,28 +30407,40 @@ "in": "query", "name": "avg_order_value_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result to items with specified user IDs.", "in": "query", "name": "users", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Filter out results where any of the passed fields are empty", @@ -18811,7 +30448,17 @@ "name": "filter_empty", "required": false, "schema": { - "items": { "enum": ["email", "name", "country", "city", "state", "postcode"], "type": "string" } + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } } }, { @@ -18819,12 +30466,22 @@ "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, "description": "OK" } } @@ -18833,48 +30490,73 @@ "/wc-analytics/customers/{id}": { "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -18883,17 +30565,17 @@ "required": false, "schema": { "enum": [ - "username", - "name", - "country", + "avg_order_value", "city", - "state", - "postcode", - "date_registered", + "country", "date_last_active", + "date_registered", + "name", "orders_count", + "postcode", + "state", "total_spend", - "avg_order_value" + "username" ] } }, @@ -18909,21 +30591,30 @@ "in": "query", "name": "registered_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", @@ -18937,7 +30628,14 @@ "in": "query", "name": "searchby", "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } }, { "description": "Limit response to objects with specific names.", @@ -19000,28 +30698,40 @@ "in": "query", "name": "last_active_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_active_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "last_active_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "registered_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects with an order count greater than or equal to given integer.", @@ -19042,7 +30752,11 @@ "in": "query", "name": "orders_count_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with a total order spend greater than or equal to given number.", @@ -19063,7 +30777,11 @@ "in": "query", "name": "total_spend_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with an average order spend greater than or equal to given number.", @@ -19084,28 +30802,40 @@ "in": "query", "name": "avg_order_value_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result to items with specified user IDs.", "in": "query", "name": "users", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Filter out results where any of the passed fields are empty", @@ -19113,7 +30843,17 @@ "name": "filter_empty", "required": false, "schema": { - "items": { "enum": ["email", "name", "country", "city", "state", "postcode"], "type": "string" } + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } } }, { @@ -19121,12 +30861,22 @@ "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, "description": "OK" } } @@ -19136,7 +30886,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -19146,7 +30902,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -19156,7 +30918,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -19175,7 +30943,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -19185,7 +30959,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_download_ips" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_download_ips" + } + } + }, "description": "OK" } } @@ -19199,28 +30979,37 @@ "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 20, "minimum": 1 } + "schema": { + "maximum": 20, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "URL query to persist across links.", @@ -19232,7 +31021,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, "description": "OK" } } @@ -19242,7 +31037,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, "description": "OK" } } @@ -19256,35 +31057,51 @@ "in": "path", "name": "leaderboard", "required": true, - "schema": { "enum": ["customers", "coupons", "categories", "products"] } + "schema": { + "enum": [ + "categories", + "coupons", + "customers", + "products" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 20, "minimum": 1 } + "schema": { + "maximum": 20, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "URL query to persist across links.", @@ -19296,7 +31113,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, "description": "OK" } } @@ -19310,21 +31133,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -19338,28 +31171,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -19373,14 +31214,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -19394,28 +31243,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to orders which have specific statuses.", @@ -19426,15 +31297,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -19473,14 +31344,22 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to orders matching part of an order number.", @@ -19492,7 +31371,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19503,32 +31388,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19537,7 +31464,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19550,32 +31483,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19584,7 +31559,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -19595,32 +31576,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19629,7 +31652,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -19640,32 +31669,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19674,7 +31745,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -19696,7 +31773,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -19705,7 +31785,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19724,12 +31810,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19749,32 +31846,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19783,7 +31922,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19803,32 +31948,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19837,7 +32024,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19857,32 +32050,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -19891,7 +32126,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -19905,21 +32146,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Search by similar product name or SKU.", @@ -19933,28 +32185,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -19968,14 +32228,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -19989,7 +32257,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -20001,17 +32274,17 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", - "rating", - "menu_order", + "popularity", "price", - "popularity", - "rating" + "rating", + "rating", + "rating", + "slug", + "title" ] } }, @@ -20020,14 +32293,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -20041,14 +32322,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -20125,21 +32423,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit results to those with a SKU that partially matches a string.", @@ -20158,7 +32470,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -20169,7 +32487,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -20178,36 +32499,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -20216,50 +32573,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -20268,7 +32712,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -20282,7 +32732,12 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Search by similar attribute name.", @@ -20294,7 +32749,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20305,16 +32766,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -20322,7 +32798,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20335,14 +32817,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -20351,7 +32845,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20362,14 +32862,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -20378,7 +32890,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20389,14 +32907,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -20405,7 +32935,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20426,21 +32962,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -20454,14 +33000,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -20475,14 +33029,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -20516,7 +33085,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20537,15 +33110,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -20554,7 +33139,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20577,9 +33166,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20592,7 +33190,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20612,9 +33216,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20627,7 +33240,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20647,9 +33266,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20662,7 +33290,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -20704,7 +33338,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20731,13 +33369,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20765,9 +33412,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20781,7 +33437,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20809,9 +33469,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20825,7 +33494,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20853,9 +33526,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -20869,7 +33551,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -20904,7 +33590,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20923,12 +33615,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20948,14 +33651,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -20964,7 +33679,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -20984,14 +33705,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -21000,7 +33733,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -21020,14 +33759,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -21036,7 +33787,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -21055,7 +33812,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -21076,21 +33839,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -21104,14 +33877,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -21125,14 +33906,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -21159,7 +33955,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -21173,7 +33973,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -21182,36 +33985,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -21220,50 +34059,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -21272,7 +34198,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21283,7 +34215,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -21292,36 +34227,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -21330,50 +34301,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -21382,7 +34440,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21393,7 +34457,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -21402,36 +34469,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -21440,50 +34543,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -21492,7 +34682,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21506,21 +34702,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -21534,14 +34740,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -21555,14 +34769,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -21595,7 +34824,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21606,18 +34841,39 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -21625,7 +34881,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21638,12 +34900,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21656,7 +34936,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21667,12 +34953,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21685,7 +34989,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21696,12 +35006,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21714,7 +35042,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -21748,7 +35082,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21767,12 +35107,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21792,12 +35143,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21810,7 +35179,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21830,12 +35205,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21848,7 +35241,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21868,12 +35267,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -21886,7 +35303,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -21900,20 +35323,37 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit result set to products assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["draft", "pending", "private", "publish", "future"] } + "schema": { + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Count Low in Stock Items" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/Count Low in Stock Items" + } + } }, "description": "OK" } @@ -21928,33 +35368,57 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit result set to products assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["draft", "pending", "private", "publish", "future"] } + "schema": { + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -21968,21 +35432,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -21996,28 +35470,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to reviews published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -22031,54 +35517,95 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "product"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ] + } }, { "description": "Limit result set to reviews assigned to specific user IDs.", "in": "query", "name": "reviewer", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes reviews assigned to specific user IDs.", "in": "query", "name": "reviewer_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to that from a specific author email.", "in": "query", "name": "reviewer_email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to reviews assigned to specific product IDs.", "in": "query", "name": "product", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to reviews assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "hold", "approved", "spam", "trash"] } + "schema": { + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22094,14 +35621,40 @@ "required": true, "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "Review content.", "required": true, "type": "string" }, - "reviewer": { "description": "Name of the reviewer.", "required": true, "type": "string" }, - "reviewer_email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + }, + "reviewer": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "reviewer_email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, - "required": ["product_id", "reviewer", "reviewer_email", "review"], + "required": [ + "product_id", + "review", + "reviewer", + "reviewer_email" + ], "type": "object" } } @@ -22109,7 +35662,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22126,12 +35685,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22140,7 +35717,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -22155,12 +35738,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22169,7 +35770,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -22184,12 +35791,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22198,7 +35823,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -22220,7 +35851,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -22229,7 +35863,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22248,12 +35888,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22277,12 +35928,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22291,7 +35960,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22315,12 +35990,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22329,7 +36022,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22353,12 +36052,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -22367,7 +36084,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -22381,21 +36104,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -22409,28 +36143,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -22444,14 +36186,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -22465,7 +36215,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -22477,14 +36232,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ] } }, @@ -22493,14 +36248,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -22514,14 +36277,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -22605,28 +36385,44 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to specific product categorie ids.", "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific product tag ids.", "in": "query", "name": "tags", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific amount of suggested products.", @@ -22638,7 +36434,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22660,7 +36462,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -22669,7 +36474,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22688,12 +36499,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22713,7 +36536,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -22722,36 +36548,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -22760,50 +36622,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -22812,7 +36761,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22832,7 +36787,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -22841,36 +36799,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -22879,50 +36873,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -22931,7 +37012,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -22951,7 +37038,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -22960,36 +37050,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -22998,50 +37124,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23050,7 +37263,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -23072,7 +37291,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -23081,36 +37303,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23119,50 +37377,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23171,7 +37516,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -23192,21 +37543,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Search by similar product name, SKU, or attribute value.", @@ -23220,28 +37581,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -23255,14 +37624,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -23276,28 +37653,51 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -23311,7 +37711,17 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -23346,21 +37756,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit result set to products with or without price.", @@ -23377,9 +37801,18 @@ "schema": { "items": { "properties": { - "attribute": { "description": "Attribute slug.", "type": "string" }, - "term": { "description": "Attribute term.", "type": "string" }, - "terms": { "description": "Attribute terms.", "type": "array" } + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } }, "type": "object" } @@ -23388,7 +37821,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23408,29 +37847,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23439,31 +37899,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23472,7 +37998,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23494,29 +38026,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23525,31 +38078,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23558,7 +38177,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -23578,29 +38203,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23609,31 +38255,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23642,7 +38354,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -23662,29 +38380,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23693,31 +38432,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23726,7 +38531,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -23748,31 +38559,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_values": { + "description": "Default values for generated variations.", + "type": "object" + }, + "delete": { + "description": "Deletes unused variations.", + "type": "boolean" + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "default_values": { "description": "Default values for generated variations.", "type": "object" }, - "delete": { "description": "Deletes unused variations.", "type": "boolean" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23781,31 +38619,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23814,7 +38718,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23843,7 +38753,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -23852,7 +38765,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23878,12 +38797,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -23910,29 +38840,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -23941,31 +38892,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -23974,7 +38991,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -24001,29 +39024,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -24032,31 +39076,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -24065,7 +39175,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -24092,29 +39208,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -24123,31 +39260,97 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product parent name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product parent name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -24156,7 +39359,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -24170,12 +39379,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, "description": "OK" } } @@ -24189,42 +39408,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -24232,7 +39470,14 @@ "name": "orderby", "required": false, "schema": { - "enum": ["category_id", "items_sold", "net_revenue", "orders_count", "products_count", "category"] + "enum": [ + "category", + "category_id", + "items_sold", + "net_revenue", + "orders_count", + "products_count" + ] } }, { @@ -24240,7 +39485,16 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Limit result set to items that have the specified order status.", @@ -24251,15 +39505,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -24274,15 +39528,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -24293,7 +39547,11 @@ "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Add additional piece of info about each category to the report.", @@ -24312,7 +39570,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_categories" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_categories" + } + } + }, "description": "OK" } } @@ -24326,49 +39590,75 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["coupon_id", "code", "amount", "orders_count"] } + "schema": { + "enum": [ + "amount", + "code", + "coupon_id", + "orders_count" + ] + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -24382,7 +39672,11 @@ "in": "query", "name": "coupons", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Add additional piece of info about each coupon to the report.", @@ -24394,7 +39688,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupons" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupons" + } + } + }, "description": "OK" } } @@ -24408,49 +39708,75 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "amount", "coupons_count", "orders_count"] } + "schema": { + "enum": [ + "amount", + "coupons_count", + "date", + "orders_count" + ] + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -24464,33 +39790,63 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Limit result set to coupons assigned specific coupon IDs.", "in": "query", "name": "coupons", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "variation", "category", "coupon"] } + "schema": { + "enum": [ + "category", + "coupon", + "product", + "variation" + ] + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupons_stats" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupons_stats" + } + } + }, "description": "OK" } } @@ -24504,42 +39860,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -24548,17 +39923,17 @@ "required": false, "schema": { "enum": [ - "username", - "name", - "country", + "avg_order_value", "city", - "state", - "postcode", - "date_registered", + "country", "date_last_active", + "date_registered", + "name", "orders_count", + "postcode", + "state", "total_spend", - "avg_order_value" + "username" ] } }, @@ -24574,21 +39949,30 @@ "in": "query", "name": "registered_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", @@ -24602,7 +39986,14 @@ "in": "query", "name": "searchby", "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } }, { "description": "Limit response to objects with specific names.", @@ -24665,28 +40056,40 @@ "in": "query", "name": "last_active_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_active_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "last_active_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "registered_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects with an order count greater than or equal to given integer.", @@ -24707,7 +40110,11 @@ "in": "query", "name": "orders_count_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with a total order spend greater than or equal to given number.", @@ -24728,7 +40135,11 @@ "in": "query", "name": "total_spend_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with an average order spend greater than or equal to given number.", @@ -24749,35 +40160,51 @@ "in": "query", "name": "avg_order_value_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result to items with specified customer IDs.", "in": "query", "name": "customers", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result to items with specified user IDs.", "in": "query", "name": "users", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Filter out results where any of the passed fields are empty", @@ -24785,13 +40212,29 @@ "name": "filter_empty", "required": false, "schema": { - "items": { "enum": ["email", "name", "country", "city", "state", "postcode"], "type": "string" } + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, "description": "OK" } } @@ -24805,28 +40248,42 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "registered_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", @@ -24840,7 +40297,14 @@ "in": "query", "name": "searchby", "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } }, { "description": "Limit response to objects with specific names.", @@ -24903,28 +40367,40 @@ "in": "query", "name": "last_active_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_active_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "last_active_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "in": "query", "name": "registered_between", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects with an order count greater than or equal to given integer.", @@ -24945,7 +40421,11 @@ "in": "query", "name": "orders_count_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with a total order spend greater than or equal to given number.", @@ -24966,7 +40446,11 @@ "in": "query", "name": "total_spend_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with an average order spend greater than or equal to given number.", @@ -24987,35 +40471,51 @@ "in": "query", "name": "avg_order_value_between", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "in": "query", "name": "last_order_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result to items with specified customer IDs.", "in": "query", "name": "customers", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25028,7 +40528,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customers_stats" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers_stats" + } + } }, "description": "OK" } @@ -25043,112 +40547,173 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "product"] } + "schema": { + "enum": [ + "date", + "product" + ] + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: products, orders, username, ip_address.", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit result set to items that have the specified product(s) assigned.", "in": "query", "name": "product_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified product(s) assigned.", "in": "query", "name": "product_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified order IDs.", "in": "query", "name": "order_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified order IDs.", "in": "query", "name": "order_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that have the specified user IDs.", "in": "query", "name": "customer_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that don't have the specified user IDs.", "in": "query", "name": "customer_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that have a specified IP address.", "in": "query", "name": "ip_address_includes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects that don't have a specified IP address.", "in": "query", "name": "ip_address_excludes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25160,7 +40725,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_downloads" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_downloads" + } + } + }, "description": "OK" } } @@ -25174,49 +40745,73 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "download_count"] } + "schema": { + "enum": [ + "date", + "download_count" + ] + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25230,82 +40825,138 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit result set to items that have the specified product(s) assigned.", "in": "query", "name": "product_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified product(s) assigned.", "in": "query", "name": "product_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified order IDs.", "in": "query", "name": "order_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified order IDs.", "in": "query", "name": "order_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that have the specified customer IDs.", "in": "query", "name": "customer_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that don't have the specified customer IDs.", "in": "query", "name": "customer_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to objects that have a specified IP address.", "in": "query", "name": "ip_address_includes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit response to objects that don't have a specified IP address.", "in": "query", "name": "ip_address_excludes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders_stats" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders_stats" + } + } + }, "description": "OK" } } @@ -25318,8 +40969,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "days": { "description": "Number of days to import.", "type": "integer" }, - "skip_existing": { "description": "Skip importing existing order data.", "type": "boolean" } + "days": { + "description": "Number of days to import.", + "type": "integer" + }, + "skip_existing": { + "description": "Skip importing existing order data.", + "type": "boolean" + } }, "type": "object" } @@ -25328,7 +40985,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25339,8 +41002,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "days": { "description": "Number of days to import.", "type": "integer" }, - "skip_existing": { "description": "Skip importing existing order data.", "type": "boolean" } + "days": { + "description": "Number of days to import.", + "type": "integer" + }, + "skip_existing": { + "description": "Skip importing existing order data.", + "type": "boolean" + } }, "type": "object" } @@ -25349,7 +41018,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25360,8 +41035,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "days": { "description": "Number of days to import.", "type": "integer" }, - "skip_existing": { "description": "Skip importing existing order data.", "type": "boolean" } + "days": { + "description": "Number of days to import.", + "type": "integer" + }, + "skip_existing": { + "description": "Skip importing existing order data.", + "type": "boolean" + } }, "type": "object" } @@ -25370,7 +41051,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25380,7 +41067,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25388,7 +41081,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25396,7 +41095,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25406,7 +41111,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25414,7 +41125,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25422,7 +41139,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25432,7 +41155,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25446,7 +41175,9 @@ "in": "query", "name": "days", "required": false, - "schema": { "minimum": 0 } + "schema": { + "minimum": 0 + } }, { "description": "Skip importing existing order data.", @@ -25458,7 +41189,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, "description": "OK" } } @@ -25472,105 +41209,162 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "num_items_sold", "net_total"] } + "schema": { + "enum": [ + "date", + "net_total", + "num_items_sold" + ] + } }, { "description": "Limit result set to items that have the specified product(s) assigned.", "in": "query", "name": "product_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified product(s) assigned.", "in": "query", "name": "product_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified variation(s) assigned.", "in": "query", "name": "variation_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified variation(s) assigned.", "in": "query", "name": "variation_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified coupon(s) assigned.", "in": "query", "name": "coupon_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified coupon(s) assigned.", "in": "query", "name": "coupon_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified tax rate(s) assigned.", "in": "query", "name": "tax_rate_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", "in": "query", "name": "tax_rate_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified order status.", @@ -25581,15 +41375,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -25604,15 +41398,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -25623,14 +41417,28 @@ "in": "query", "name": "customer_type", "required": false, - "schema": { "enum": ["", "returning", "new"] } + "schema": { + "enum": [ + "", + "new", + "returning" + ] + } }, { "description": "Limit result set to specific types of refunds.", "in": "query", "name": "refunds", "required": false, - "schema": { "enum": ["", "all", "partial", "full", "none"] } + "schema": { + "enum": [ + "", + "all", + "full", + "none", + "partial" + ] + } }, { "description": "Add additional piece of info about each coupon to the report.", @@ -25644,28 +41452,44 @@ "in": "query", "name": "order_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified order IDs.", "in": "query", "name": "order_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to orders that include products with the specified attributes.", "in": "query", "name": "attribute_is", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Limit result set to orders that don't include products with the specified attributes.", "in": "query", "name": "attribute_is_not", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25677,7 +41501,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders" + } + } + }, "description": "OK" } } @@ -25691,63 +41521,103 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "net_revenue", "orders_count", "avg_order_value"] } + "schema": { + "enum": [ + "avg_order_value", + "date", + "net_revenue", + "orders_count" + ] + } }, { "description": "Time interval to use for buckets in the returned data.", "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit result set to items that have the specified order status.", @@ -25758,15 +41628,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -25781,15 +41651,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -25800,105 +41670,175 @@ "in": "query", "name": "product_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified product(s) assigned.", "in": "query", "name": "product_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified variation(s) assigned.", "in": "query", "name": "variation_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified variation(s) assigned.", "in": "query", "name": "variation_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified coupon(s) assigned.", "in": "query", "name": "coupon_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified coupon(s) assigned.", "in": "query", "name": "coupon_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that have the specified tax rate(s) assigned.", "in": "query", "name": "tax_rate_includes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", "in": "query", "name": "tax_rate_excludes", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Alias for customer_type (deprecated).", "in": "query", "name": "customer", "required": false, - "schema": { "enum": ["new", "returning"] } + "schema": { + "enum": [ + "new", + "returning" + ] + } }, { "description": "Limit result set to orders that have the specified customer_type", "in": "query", "name": "customer_type", "required": false, - "schema": { "enum": ["new", "returning"] } + "schema": { + "enum": [ + "new", + "returning" + ] + } }, { "description": "Limit result set to specific types of refunds.", "in": "query", "name": "refunds", "required": false, - "schema": { "enum": ["", "all", "partial", "full", "none"] } + "schema": { + "enum": [ + "", + "all", + "full", + "none", + "partial" + ] + } }, { "description": "Limit result set to orders that include products with the specified attributes.", "in": "query", "name": "attribute_is", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Limit result set to orders that don't include products with the specified attributes.", "in": "query", "name": "attribute_is_not", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "category", "variation", "coupon", "customer_type"] } + "schema": { + "enum": [ + "category", + "coupon", + "customer_type", + "product", + "variation" + ] + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Force retrieval of fresh data instead of from the cache.", @@ -25910,7 +41850,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders_stats" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders_stats" + } + } + }, "description": "OK" } } @@ -25924,7 +41870,12 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.", @@ -25934,21 +41885,21 @@ "schema": { "items": { "enum": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "type": "string" } @@ -25959,20 +41910,28 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_performance_indicator" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_performance_indicator" + } + } }, "description": "OK" } @@ -25987,7 +41946,12 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.", @@ -25997,21 +41961,21 @@ "schema": { "items": { "enum": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "type": "string" } @@ -26022,20 +41986,28 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_performance_indicator" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_performance_indicator" + } + } }, "description": "OK" } @@ -26050,42 +42022,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26093,7 +42084,15 @@ "name": "orderby", "required": false, "schema": { - "enum": ["date", "net_revenue", "orders_count", "items_sold", "product_name", "variations", "sku"] + "enum": [ + "date", + "items_sold", + "net_revenue", + "orders_count", + "product_name", + "sku", + "variations" + ] } }, { @@ -26108,21 +42107,34 @@ "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "in": "query", "name": "match", "required": false, - "schema": { "enum": ["all", "any"] } + "schema": { + "enum": [ + "all", + "any" + ] + } }, { "description": "Limit result to items with specified product IDs.", "in": "query", "name": "products", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Add additional piece of info about each product to the report.", @@ -26134,7 +42146,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_products" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_products" + } + } + }, "description": "OK" } } @@ -26148,42 +42166,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26192,15 +42229,15 @@ "required": false, "schema": { "enum": [ - "date", - "net_revenue", "coupons", - "refunds", - "shipping", - "taxes", + "date", + "items_sold", + "net_revenue", "net_revenue", "orders_count", - "items_sold" + "refunds", + "shipping", + "taxes" ] } }, @@ -26216,48 +42253,83 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Limit result to items from the specified categories.", "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result to items with specified product IDs.", "in": "query", "name": "products", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result to items with specified variation IDs.", "in": "query", "name": "variations", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "category", "variation"] } + "schema": { + "enum": [ + "category", + "product", + "variation" + ] + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_products_stats" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_products_stats" + } + } }, "description": "OK" } @@ -26272,42 +42344,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26316,16 +42407,16 @@ "required": false, "schema": { "enum": [ - "date", - "total_sales", "coupons", + "date", + "gross_sales", + "items_sold", + "net_revenue", + "orders_count", "refunds", "shipping", "taxes", - "net_revenue", - "orders_count", - "items_sold", - "gross_sales" + "total_sales" ] } }, @@ -26341,26 +42432,55 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "category", "variation", "coupon", "customer_type"] } + "schema": { + "enum": [ + "category", + "coupon", + "customer_type", + "product", + "variation" + ] + } }, { "description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.", "in": "query", "name": "date_type", "required": false, - "schema": { "enum": ["date_paid", "date_created", "date_completed"] } + "schema": { + "enum": [ + "date_completed", + "date_created", + "date_paid" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_revenue_stats" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_revenue_stats" + } + } + }, "description": "OK" } } @@ -26374,49 +42494,82 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["stock_status", "stock_quantity", "date", "id", "include", "title", "sku"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "sku", + "stock_quantity", + "stock_status", + "title" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -26430,26 +42583,48 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to items assigned a stock report type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["all", "lowstock", "instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "all", + "instock", + "lowstock", + "onbackorder", + "outofstock" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_stock" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_stock" + } + } + }, "description": "OK" } } @@ -26463,13 +42638,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customers_stats" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers_stats" + } + } }, "description": "OK" } @@ -26484,42 +42668,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26529,13 +42732,13 @@ "schema": { "enum": [ "name", - "tax_rate_id", - "tax_code", - "rate", "order_tax", - "total_tax", + "orders_count", + "rate", "shipping_tax", - "orders_count" + "tax_code", + "tax_rate_id", + "total_tax" ] } }, @@ -26551,12 +42754,22 @@ "in": "query", "name": "taxes", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_taxes" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_taxes" + } + } + }, "description": "OK" } } @@ -26570,276 +42783,61 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit response to resources published after a given ISO8601 compliant date.", "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "description": "Sort collection by object attribute.", - "in": "query", - "name": "orderby", - "required": false, - "schema": { "enum": ["date", "items_sold", "total_sales", "orders_count", "products_count"] } - }, - { - "description": "Force retrieval of fresh data instead of from the cache.", - "in": "query", - "name": "force_cache_refresh", - "required": false, - "schema": {} - }, - { - "description": "Time interval to use for buckets in the returned data.", - "in": "query", - "name": "interval", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", - "in": "query", - "name": "taxes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Segment the response by additional constraint.", - "in": "query", - "name": "segmentby", - "required": false, - "schema": { "enum": ["tax_rate_id"] } - }, - { - "description": "Limit stats fields to the specified items.", - "in": "query", - "name": "fields", - "required": false, - "schema": { "items": { "type": "string" } } - } - ], - "responses": { - "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_taxes_stats" } } }, - "description": "OK" - } - } - } - }, - "/wc-analytics/reports/variations": { - "get": { - "parameters": [ - { - "description": "Scope under which the request is made; determines fields present in response.", - "in": "query", - "name": "context", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "description": "Current page of the collection.", - "in": "query", - "name": "page", - "required": false, - "schema": { "minimum": 1 } - }, - { - "description": "Maximum number of items to be returned in result set.", - "in": "query", - "name": "per_page", - "required": false, - "schema": { "maximum": 100, "minimum": 1 } - }, - { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "in": "query", - "name": "after", - "required": false, - "schema": { "format": "date-time" } - }, - { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "in": "query", - "name": "before", - "required": false, - "schema": { "format": "date-time" } - }, - { - "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "in": "query", - "name": "match", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "description": "Order sort attribute ascending or descending.", - "in": "query", - "name": "order", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "description": "Sort collection by object attribute.", - "in": "query", - "name": "orderby", - "required": false, - "schema": { "enum": ["date", "net_revenue", "orders_count", "items_sold", "sku"] } - }, - { - "description": "Limit result set to items that have the specified parent product(s).", - "in": "query", - "name": "product_includes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to items that don't have the specified parent product(s).", - "in": "query", - "name": "product_excludes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result to items with specified variation IDs.", - "in": "query", - "name": "variations", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Add additional piece of info about each variation to the report.", - "in": "query", - "name": "extended_info", - "required": false, - "schema": {} - }, - { - "description": "Limit result set to variations that include the specified attributes.", - "in": "query", - "name": "attribute_is", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "description": "Limit result set to variations that don't include the specified attributes.", - "in": "query", - "name": "attribute_is_not", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "description": "Limit result set to variations in the specified categories.", - "in": "query", - "name": "category_includes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to variations not in the specified categories.", - "in": "query", - "name": "category_excludes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Force retrieval of fresh data instead of from the cache.", - "in": "query", - "name": "force_cache_refresh", - "required": false, - "schema": {} - }, - { - "description": "Limit result to items with specified product IDs.", - "in": "query", - "name": "products", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ], - "responses": { - "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_varitations" } } }, - "description": "OK" - } - } - } - }, - "/wc-analytics/reports/variations/stats": { - "get": { - "parameters": [ - { - "description": "Scope under which the request is made; determines fields present in response.", - "in": "query", - "name": "context", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "description": "Current page of the collection.", - "in": "query", - "name": "page", - "required": false, - "schema": { "minimum": 1 } - }, - { - "description": "Maximum number of items to be returned in result set.", - "in": "query", - "name": "per_page", - "required": false, - "schema": { "maximum": 100, "minimum": 1 } - }, - { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "in": "query", - "name": "after", - "required": false, - "schema": { "format": "date-time" } - }, - { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "in": "query", - "name": "before", - "required": false, - "schema": { "format": "date-time" } - }, - { - "description": "Order sort attribute ascending or descending.", - "in": "query", - "name": "order", - "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -26849,14 +42847,10 @@ "schema": { "enum": [ "date", - "net_revenue", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", + "items_sold", "orders_count", - "items_sold" + "products_count", + "total_sales" ] } }, @@ -26872,83 +42866,501 @@ "in": "query", "name": "interval", "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } }, { - "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", + "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", "in": "query", - "name": "match", + "name": "taxes", "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "description": "Limit result to items from the specified categories.", - "in": "query", - "name": "category_includes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to variations not in the specified categories.", - "in": "query", - "name": "category_excludes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to items that have the specified parent product(s).", - "in": "query", - "name": "product_includes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result set to items that don't have the specified parent product(s).", - "in": "query", - "name": "product_excludes", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "description": "Limit result to items with specified variation IDs.", - "in": "query", - "name": "variations", - "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Segment the response by additional constraint.", "in": "query", "name": "segmentby", "required": false, - "schema": { "enum": ["product", "category", "variation"] } + "schema": { + "enum": [ + "tax_rate_id" + ] + } }, { "description": "Limit stats fields to the specified items.", "in": "query", "name": "fields", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_taxes_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/variations": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + }, + { + "description": "Current page of the collection.", + "in": "query", + "name": "page", + "required": false, + "schema": { + "minimum": 1 + } + }, + { + "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 1 + } + }, + { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", + "in": "query", + "name": "match", + "required": false, + "schema": { + "enum": [ + "all", + "any" + ] + } + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by object attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "date", + "items_sold", + "net_revenue", + "orders_count", + "sku" + ] + } + }, + { + "description": "Limit result set to items that have the specified parent product(s).", + "in": "query", + "name": "product_includes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to items that don't have the specified parent product(s).", + "in": "query", + "name": "product_excludes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result to items with specified variation IDs.", + "in": "query", + "name": "variations", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Add additional piece of info about each variation to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to variations that include the specified attributes.", + "in": "query", + "name": "attribute_is", + "required": false, + "schema": { + "items": { + "type": "array" + } + } + }, + { + "description": "Limit result set to variations that don't include the specified attributes.", + "in": "query", + "name": "attribute_is_not", + "required": false, + "schema": { + "items": { + "type": "array" + } + } + }, + { + "description": "Limit result set to variations in the specified categories.", + "in": "query", + "name": "category_includes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to variations not in the specified categories.", + "in": "query", + "name": "category_excludes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "description": "Limit result to items with specified product IDs.", + "in": "query", + "name": "products", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_varitations" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/variations/stats": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + }, + { + "description": "Current page of the collection.", + "in": "query", + "name": "page", + "required": false, + "schema": { + "minimum": 1 + } + }, + { + "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 1 + } + }, + { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by object attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "coupons", + "date", + "items_sold", + "net_revenue", + "net_revenue", + "orders_count", + "refunds", + "shipping", + "taxes" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "description": "Time interval to use for buckets in the returned data.", + "in": "query", + "name": "interval", + "required": false, + "schema": { + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ] + } + }, + { + "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", + "in": "query", + "name": "match", + "required": false, + "schema": { + "enum": [ + "all", + "any" + ] + } + }, + { + "description": "Limit result to items from the specified categories.", + "in": "query", + "name": "category_includes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to variations not in the specified categories.", + "in": "query", + "name": "category_excludes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to items that have the specified parent product(s).", + "in": "query", + "name": "product_includes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to items that don't have the specified parent product(s).", + "in": "query", + "name": "product_excludes", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result to items with specified variation IDs.", + "in": "query", + "name": "variations", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Segment the response by additional constraint.", + "in": "query", + "name": "segmentby", + "required": false, + "schema": { + "enum": [ + "category", + "product", + "variation" + ] + } + }, + { + "description": "Limit stats fields to the specified items.", + "in": "query", + "name": "fields", + "required": false, + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to orders that include products with the specified attributes.", "in": "query", "name": "attribute_is", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } }, { "description": "Limit result set to orders that don't include products with the specified attributes.", "in": "query", "name": "attribute_is_not", "required": false, - "schema": { "items": { "type": "array" } } + "schema": { + "items": { + "type": "array" + } + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_variations_stats" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_variations_stats" + } + } }, "description": "OK" } @@ -26957,7 +43369,15 @@ }, "/wc-analytics/reports/{type}/export": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "type", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26967,7 +43387,10 @@ "description": "When true, email a link to download the export to the requesting user.", "type": "boolean" }, - "report_args": { "description": "Parameters to pass on to the exported report.", "type": "object" } + "report_args": { + "description": "Parameters to pass on to the exported report.", + "type": "object" + } }, "type": "object" } @@ -26976,13 +43399,27 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "type", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26992,7 +43429,10 @@ "description": "When true, email a link to download the export to the requesting user.", "type": "boolean" }, - "report_args": { "description": "Parameters to pass on to the exported report.", "type": "object" } + "report_args": { + "description": "Parameters to pass on to the exported report.", + "type": "object" + } }, "type": "object" } @@ -27001,13 +43441,27 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "type", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27017,7 +43471,10 @@ "description": "When true, email a link to download the export to the requesting user.", "type": "boolean" }, - "report_args": { "description": "Parameters to pass on to the exported report.", "type": "object" } + "report_args": { + "description": "Parameters to pass on to the exported report.", + "type": "object" + } }, "type": "object" } @@ -27026,7 +43483,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, "description": "OK" } } @@ -27035,12 +43498,30 @@ "/wc-analytics/reports/{type}/export/{export_id}/status": { "get": { "parameters": [ - { "description": "", "in": "path", "name": "type", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "export_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "export_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export_status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export_status" + } + } + }, "description": "OK" } } @@ -27049,12 +43530,30 @@ "/wc-analytics/settings/{group_id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27062,16 +43561,35 @@ }, "/wc-analytics/settings/{group_id}/batch": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27081,22 +43599,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27106,22 +43649,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27131,7 +43699,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -27140,7 +43714,13 @@ "/wc-analytics/settings/{group_id}/{id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -27148,11 +43728,23 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27166,17 +43758,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27186,7 +43795,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27200,17 +43815,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27220,7 +43852,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27234,17 +43872,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -27254,7 +43909,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -27268,21 +43929,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -27296,21 +43967,38 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { "description": "Sort by tax class.", "in": "query", "name": "class", "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } }, { "description": "Search by similar tax code.", @@ -27324,12 +44012,22 @@ "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27340,16 +44038,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27358,13 +44074,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27373,7 +44098,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27386,16 +44117,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27404,13 +44153,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27419,7 +44177,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -27430,16 +44194,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27448,13 +44230,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27463,7 +44254,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -27474,16 +44271,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27492,13 +44307,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27507,7 +44331,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -27541,7 +44371,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27560,12 +44396,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27585,16 +44432,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27603,13 +44468,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27618,7 +44492,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27638,16 +44518,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27656,13 +44554,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27671,7 +44578,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27691,16 +44604,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -27709,13 +44640,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -27724,7 +44664,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -27738,21 +44684,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Search by similar product name, SKU, or attribute value.", @@ -27766,28 +44722,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -27801,14 +44765,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -27822,28 +44794,51 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -27857,7 +44852,17 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -27892,21 +44897,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit result set to products with or without price.", @@ -27923,9 +44942,18 @@ "schema": { "items": { "properties": { - "attribute": { "description": "Attribute slug.", "type": "string" }, - "term": { "description": "Attribute term.", "type": "string" }, - "terms": { "description": "Attribute terms.", "type": "array" } + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } }, "type": "object" } @@ -27934,7 +44962,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -27943,10 +44977,26 @@ "/wc-telemetry": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc-telemetry/tracker": { @@ -27961,25 +45011,56 @@ "required": false, "type": "string" }, - "platform": { "description": "Platform to track.", "required": true, "type": "string" }, - "version": { "description": "Platform version to track.", "required": true, "type": "string" } + "platform": { + "description": "Platform to track.", + "required": true, + "type": "string" + }, + "version": { + "description": "Platform version to track.", + "required": true, + "type": "string" + } }, - "required": ["platform", "version"], + "required": [ + "platform", + "version" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/private": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/private/ai/business-description": { @@ -28002,7 +45083,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/ai/business-description" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/business-description" + } + } }, "description": "OK" } @@ -28028,7 +45113,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/images" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/images" + } + } + }, "description": "OK" } } @@ -28038,7 +45129,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/patterns" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/patterns" + } + } + }, "description": "OK" } } @@ -28053,7 +45150,10 @@ "description": "The business description for a given store.", "type": "string" }, - "images": { "description": "The images for a given store.", "type": "object" } + "images": { + "description": "The images for a given store.", + "type": "object" + } }, "type": "object" } @@ -28062,7 +45162,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/patterns" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/patterns" + } + } + }, "description": "OK" } } @@ -28091,7 +45197,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/product" + } + } + }, "description": "OK" } } @@ -28101,7 +45213,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/products" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/products" + } + } + }, "description": "OK" } } @@ -28116,7 +45234,10 @@ "description": "The business description for a given store.", "type": "string" }, - "images": { "description": "The images for a given store.", "type": "object" } + "images": { + "description": "The images for a given store.", + "type": "object" + } }, "type": "object" } @@ -28125,7 +45246,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/products" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/products" + } + } + }, "description": "OK" } } @@ -28135,7 +45262,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/store-info" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/store-info" + } + } + }, "description": "OK" } } @@ -28160,7 +45293,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/store-title" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/store-title" + } + } + }, "description": "OK" } } @@ -28170,7 +45309,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patterns" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/patterns" + } + } + }, "description": "OK" } } @@ -28178,7 +45323,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patterns" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/patterns" + } + } + }, "description": "OK" } } @@ -28187,10 +45338,26 @@ "/wc/store": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/store/batch": { @@ -28199,14 +45366,28 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "requests": { "required": true, "type": "array" }, "validation": { "type": "string" } }, - "required": ["requests"], + "properties": { + "requests": { + "required": true, + "type": "array" + }, + "validation": { + "type": "string" + } + }, + "required": [ + "requests" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/store/cart": { @@ -28217,12 +45398,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28235,9 +45427,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "id": { "description": "The basket item product or variation ID.", "type": "integer" }, - "quantity": { "description": "Quantity of this item to add to the basket.", "type": "integer" }, - "variation": { "description": "Chosen attributes (for variations).", "type": "array" } + "id": { + "description": "The basket item product or variation ID.", + "type": "integer" + }, + "quantity": { + "description": "Quantity of this item to add to the basket.", + "type": "integer" + }, + "variation": { + "description": "Chosen attributes (for variations).", + "type": "array" + } }, "type": "object" } @@ -28246,7 +45447,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28259,7 +45466,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string" } + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } }, "type": "object" } @@ -28268,7 +45478,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28278,7 +45494,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28290,12 +45512,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28306,7 +45539,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "The coupon's unique code.", "type": "string" }, + "code": { + "description": "The coupon's unique code.", + "type": "string" + }, "discount_type": { "description": "The discount type for the coupon (eg percentage or fixed amount)", "type": "string" @@ -28319,7 +45555,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28338,7 +45580,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28357,12 +45605,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -28375,7 +45634,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "data": { "description": "Additional data to pass to the extension", "type": "object" }, + "data": { + "description": "Additional data to pass to the extension", + "type": "object" + }, "namespace": { "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", "type": "string" @@ -28388,7 +45650,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart-extensions" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart-extensions" + } + } + }, "description": "OK" } } @@ -28398,7 +45666,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28410,12 +45684,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28424,13 +45709,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28449,7 +45747,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28468,12 +45772,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28491,13 +45806,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28515,13 +45843,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28539,13 +45880,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -28558,7 +45912,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string" } + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } }, "type": "object" } @@ -28567,7 +45924,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28580,7 +45943,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "key": { "description": "Unique identifier (key) for the basket item.", "type": "string" } + "key": { + "description": "Unique identifier (key) for the basket item.", + "type": "string" + } }, "type": "object" } @@ -28589,7 +45955,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28605,7 +45977,11 @@ "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "required": false, - "type": ["integer", "string", "null"] + "type": [ + "integer", + "null", + "string" + ] }, "rate_id": { "description": "The chosen rate ID for the package.", @@ -28613,7 +45989,9 @@ "type": "string" } }, - "required": ["rate_id"], + "required": [ + "rate_id" + ], "type": "object" } } @@ -28621,7 +45999,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28634,8 +46018,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing_address": { "description": "Billing address.", "type": "object" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "billing_address": { + "description": "Billing address.", + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, "type": "object" } @@ -28644,7 +46034,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28657,8 +46053,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "key": { "description": "Unique identifier (key) for the basket item to update.", "type": "string" }, - "quantity": { "description": "New quantity of the item in the basket.", "type": "integer" } + "key": { + "description": "Unique identifier (key) for the basket item to update.", + "type": "string" + }, + "quantity": { + "description": "New quantity of the item in the basket.", + "type": "integer" + } }, "type": "object" } @@ -28667,7 +46069,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -28681,12 +46089,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, "description": "OK" } } @@ -28701,7 +46120,11 @@ "description": "Additional fields to be persisted on the order.", "type": "object" }, - "billing_address": { "description": "Billing address.", "required": true, "type": "object" }, + "billing_address": { + "description": "Billing address.", + "required": true, + "type": "object" + }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "type": "boolean" @@ -28714,7 +46137,9 @@ "description": "Customer password for new accounts, if applicable.", "type": "string" }, - "extensions": { "type": "object" }, + "extensions": { + "type": "object" + }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array" @@ -28723,9 +46148,14 @@ "description": "The ID of the payment method being used to process the payment.", "type": "string" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, - "required": ["billing_address"], + "required": [ + "billing_address" + ], "type": "object" } } @@ -28733,7 +46163,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, "description": "OK" } } @@ -28741,7 +46177,15 @@ }, "/wc/store/checkout/{id}": { "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28751,12 +46195,18 @@ "description": "Additional fields to be persisted on the order.", "type": "object" }, - "billing_address": { "description": "Billing address.", "required": true, "type": "object" }, + "billing_address": { + "description": "Billing address.", + "required": true, + "type": "object" + }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string" }, - "extensions": { "type": "object" }, + "extensions": { + "type": "object" + }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array" @@ -28765,9 +46215,14 @@ "description": "The ID of the payment method being used to process the payment.", "type": "string" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, - "required": ["billing_address"], + "required": [ + "billing_address" + ], "type": "object" } } @@ -28775,7 +46230,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout-order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout-order" + } + } + }, "description": "OK" } } @@ -28789,13 +46250,30 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order" + } + } + }, "description": "OK" } } @@ -28809,21 +46287,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -28844,35 +46332,54 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources created before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "When limiting response using after/before, which date column to compare against.", "in": "query", "name": "date_column", "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -28886,7 +46393,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -28895,17 +46407,17 @@ "required": false, "schema": { "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ] } }, @@ -28914,21 +46426,37 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -28956,7 +46484,13 @@ "in": "query", "name": "category_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products assigned a specific tag ID.", @@ -28970,7 +46504,13 @@ "in": "query", "name": "tag_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products on sale.", @@ -29000,7 +46540,11 @@ "required": false, "schema": { "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -29022,18 +46566,26 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "sanitize_callback": "wp_parse_id_list", "type": "array" } @@ -29047,26 +46599,56 @@ "in": "query", "name": "attribute_relation", "required": false, - "schema": { "enum": ["in", "and"] } + "schema": { + "enum": [ + "and", + "in" + ] + } }, { "description": "Determines if hidden or visible catalogue products are shown.", "in": "query", "name": "catalog_visibility", "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } + "schema": { + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ] + } }, { "description": "Limit result set to products with a certain average rating.", "in": "query", "name": "rating", "required": false, - "schema": { "items": { "enum": [1, 2, 3, 4, 5], "type": "integer" } } + "schema": { + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -29080,12 +46662,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -29106,21 +46699,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -29134,28 +46737,50 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count", "menu_order", "name_num", "id"] } + "schema": { + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -29167,7 +46792,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, "description": "OK" } } @@ -29188,12 +46819,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -29207,21 +46849,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -29235,28 +46888,47 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count"] } + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -29268,7 +46940,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, "description": "OK" } } @@ -29289,12 +46967,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, "description": "OK" } } @@ -29308,21 +46998,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -29343,35 +47043,54 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources created before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "When limiting response using after/before, which date column to compare against.", "in": "query", "name": "date_column", "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -29385,7 +47104,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -29394,17 +47118,17 @@ "required": false, "schema": { "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ] } }, @@ -29413,21 +47137,37 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -29455,7 +47195,13 @@ "in": "query", "name": "category_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products assigned a specific tag ID.", @@ -29469,7 +47215,13 @@ "in": "query", "name": "tag_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products on sale.", @@ -29499,7 +47251,11 @@ "required": false, "schema": { "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -29521,18 +47277,26 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "sanitize_callback": "wp_parse_id_list", "type": "array" } @@ -29546,21 +47310,45 @@ "in": "query", "name": "attribute_relation", "required": false, - "schema": { "enum": ["in", "and"] } + "schema": { + "enum": [ + "and", + "in" + ] + } }, { "description": "Determines if hidden or visible catalogue products are shown.", "in": "query", "name": "catalog_visibility", "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } + "schema": { + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ] + } }, { "description": "Limit result set to products with a certain average rating.", "in": "query", "name": "rating", "required": false, - "schema": { "items": { "enum": [1, 2, 3, 4, 5], "type": "integer" } } + "schema": { + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + } + } }, { "description": "If true, calculates the minimum and maximum product prices for the collection.", @@ -29585,14 +47373,23 @@ "items": { "properties": { "query_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "enum": ["and", "or"], + "enum": [ + "and", + "or" + ], "readonly": true, "type": "string" }, "taxonomy": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxonomy name.", "readonly": true, "type": "string" @@ -29613,7 +47410,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product-collection-data" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-collection-data" + } + } }, "description": "OK" } @@ -29628,21 +47429,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Offset the result set by a specific number of items.", @@ -29656,14 +47467,27 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "rating", "product"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "product", + "rating" + ] + } }, { "description": "Limit result set to reviews from specific category IDs.", @@ -29682,7 +47506,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -29696,21 +47526,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -29724,28 +47564,47 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count"] } + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -29757,7 +47616,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, "description": "OK" } } @@ -29778,12 +47643,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -29792,18 +47668,35 @@ "/wc/store/products/{slug}": { "get": { "parameters": [ - { "description": "Slug of the resource.", "in": "path", "name": "slug", "required": true, "schema": {} }, + { + "description": "Slug of the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -29812,10 +47705,26 @@ "/wc/store/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/store/v1/batch": { @@ -29824,14 +47733,28 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "requests": { "required": true, "type": "array" }, "validation": { "type": "string" } }, - "required": ["requests"], + "properties": { + "requests": { + "required": true, + "type": "array" + }, + "validation": { + "type": "string" + } + }, + "required": [ + "requests" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/store/v1/cart": { @@ -29842,12 +47765,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -29860,9 +47794,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "id": { "description": "The basket item product or variation ID.", "type": "integer" }, - "quantity": { "description": "Quantity of this item to add to the basket.", "type": "integer" }, - "variation": { "description": "Chosen attributes (for variations).", "type": "array" } + "id": { + "description": "The basket item product or variation ID.", + "type": "integer" + }, + "quantity": { + "description": "Quantity of this item to add to the basket.", + "type": "integer" + }, + "variation": { + "description": "Chosen attributes (for variations).", + "type": "array" + } }, "type": "object" } @@ -29871,7 +47814,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -29884,7 +47833,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string" } + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } }, "type": "object" } @@ -29893,7 +47845,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -29903,7 +47861,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -29915,12 +47879,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -29931,7 +47906,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "The coupon's unique code.", "type": "string" }, + "code": { + "description": "The coupon's unique code.", + "type": "string" + }, "discount_type": { "description": "The discount type for the coupon (eg percentage or fixed amount)", "type": "string" @@ -29944,7 +47922,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -29963,7 +47947,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -29982,12 +47972,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, "description": "OK" } } @@ -30000,7 +48001,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "data": { "description": "Additional data to pass to the extension", "type": "object" }, + "data": { + "description": "Additional data to pass to the extension", + "type": "object" + }, "namespace": { "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", "type": "string" @@ -30013,7 +48017,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart-extensions" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart-extensions" + } + } + }, "description": "OK" } } @@ -30023,7 +48033,13 @@ "delete": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30035,12 +48051,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30049,13 +48076,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30074,7 +48114,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30093,12 +48139,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30116,13 +48173,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30140,13 +48210,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30164,13 +48247,26 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "properties": { "extensions": { "type": "object" } }, "type": "object" } + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } } } }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, "description": "OK" } } @@ -30183,7 +48279,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string" } + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } }, "type": "object" } @@ -30192,7 +48291,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30205,7 +48310,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "key": { "description": "Unique identifier (key) for the basket item.", "type": "string" } + "key": { + "description": "Unique identifier (key) for the basket item.", + "type": "string" + } }, "type": "object" } @@ -30214,7 +48322,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30230,7 +48344,11 @@ "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "required": false, - "type": ["integer", "string", "null"] + "type": [ + "integer", + "null", + "string" + ] }, "rate_id": { "description": "The chosen rate ID for the package.", @@ -30238,7 +48356,9 @@ "type": "string" } }, - "required": ["rate_id"], + "required": [ + "rate_id" + ], "type": "object" } } @@ -30246,7 +48366,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30259,8 +48385,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing_address": { "description": "Billing address.", "type": "object" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "billing_address": { + "description": "Billing address.", + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, "type": "object" } @@ -30269,7 +48401,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30282,8 +48420,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "key": { "description": "Unique identifier (key) for the basket item to update.", "type": "string" }, - "quantity": { "description": "New quantity of the item in the basket.", "type": "integer" } + "key": { + "description": "Unique identifier (key) for the basket item to update.", + "type": "string" + }, + "quantity": { + "description": "New quantity of the item in the basket.", + "type": "integer" + } }, "type": "object" } @@ -30292,7 +48436,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, "description": "OK" } } @@ -30306,12 +48456,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, "description": "OK" } } @@ -30326,7 +48487,11 @@ "description": "Additional fields to be persisted on the order.", "type": "object" }, - "billing_address": { "description": "Billing address.", "required": true, "type": "object" }, + "billing_address": { + "description": "Billing address.", + "required": true, + "type": "object" + }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "type": "boolean" @@ -30339,7 +48504,9 @@ "description": "Customer password for new accounts, if applicable.", "type": "string" }, - "extensions": { "type": "object" }, + "extensions": { + "type": "object" + }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array" @@ -30348,9 +48515,14 @@ "description": "The ID of the payment method being used to process the payment.", "type": "string" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, - "required": ["billing_address"], + "required": [ + "billing_address" + ], "type": "object" } } @@ -30358,7 +48530,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, "description": "OK" } } @@ -30366,7 +48544,15 @@ }, "/wc/store/v1/checkout/{id}": { "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30376,12 +48562,18 @@ "description": "Additional fields to be persisted on the order.", "type": "object" }, - "billing_address": { "description": "Billing address.", "required": true, "type": "object" }, + "billing_address": { + "description": "Billing address.", + "required": true, + "type": "object" + }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string" }, - "extensions": { "type": "object" }, + "extensions": { + "type": "object" + }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array" @@ -30390,9 +48582,14 @@ "description": "The ID of the payment method being used to process the payment.", "type": "string" }, - "shipping_address": { "description": "Shipping address.", "type": "object" } + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } }, - "required": ["billing_address"], + "required": [ + "billing_address" + ], "type": "object" } } @@ -30400,7 +48597,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout-order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout-order" + } + } + }, "description": "OK" } } @@ -30414,13 +48617,30 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order" + } + } + }, "description": "OK" } } @@ -30434,21 +48654,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -30469,35 +48699,54 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources created before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "When limiting response using after/before, which date column to compare against.", "in": "query", "name": "date_column", "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -30511,7 +48760,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -30520,17 +48774,17 @@ "required": false, "schema": { "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ] } }, @@ -30539,21 +48793,37 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -30581,7 +48851,13 @@ "in": "query", "name": "category_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products assigned a specific tag ID.", @@ -30595,7 +48871,13 @@ "in": "query", "name": "tag_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products on sale.", @@ -30625,7 +48907,11 @@ "required": false, "schema": { "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -30647,18 +48933,26 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "sanitize_callback": "wp_parse_id_list", "type": "array" } @@ -30672,26 +48966,56 @@ "in": "query", "name": "attribute_relation", "required": false, - "schema": { "enum": ["in", "and"] } + "schema": { + "enum": [ + "and", + "in" + ] + } }, { "description": "Determines if hidden or visible catalogue products are shown.", "in": "query", "name": "catalog_visibility", "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } + "schema": { + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ] + } }, { "description": "Limit result set to products with a certain average rating.", "in": "query", "name": "rating", "required": false, - "schema": { "items": { "enum": [1, 2, 3, 4, 5], "type": "integer" } } + "schema": { + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -30705,12 +49029,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -30731,21 +49066,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -30759,28 +49104,50 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count", "menu_order", "name_num", "id"] } + "schema": { + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -30792,7 +49159,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, "description": "OK" } } @@ -30813,12 +49186,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -30832,21 +49216,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -30860,28 +49255,47 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count"] } + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -30893,7 +49307,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, "description": "OK" } } @@ -30914,12 +49334,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, "description": "OK" } } @@ -30933,21 +49365,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -30968,35 +49410,54 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources created before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "When limiting response using after/before, which date column to compare against.", "in": "query", "name": "date_column", "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ] + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -31010,7 +49471,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -31019,17 +49485,17 @@ "required": false, "schema": { "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ] } }, @@ -31038,21 +49504,37 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -31080,7 +49562,13 @@ "in": "query", "name": "category_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products assigned a specific tag ID.", @@ -31094,7 +49582,13 @@ "in": "query", "name": "tag_operator", "required": false, - "schema": { "enum": ["in", "not_in", "and"] } + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } }, { "description": "Limit result set to products on sale.", @@ -31124,7 +49618,11 @@ "required": false, "schema": { "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -31146,18 +49644,26 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "sanitize_callback": "wp_parse_id_list", "type": "array" } @@ -31171,21 +49677,45 @@ "in": "query", "name": "attribute_relation", "required": false, - "schema": { "enum": ["in", "and"] } + "schema": { + "enum": [ + "and", + "in" + ] + } }, { "description": "Determines if hidden or visible catalogue products are shown.", "in": "query", "name": "catalog_visibility", "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } + "schema": { + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ] + } }, { "description": "Limit result set to products with a certain average rating.", "in": "query", "name": "rating", "required": false, - "schema": { "items": { "enum": [1, 2, 3, 4, 5], "type": "integer" } } + "schema": { + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + } + } }, { "description": "If true, calculates the minimum and maximum product prices for the collection.", @@ -31210,14 +49740,23 @@ "items": { "properties": { "query_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "enum": ["and", "or"], + "enum": [ + "and", + "or" + ], "readonly": true, "type": "string" }, "taxonomy": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxonomy name.", "readonly": true, "type": "string" @@ -31238,7 +49777,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product-collection-data" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-collection-data" + } + } }, "description": "OK" } @@ -31253,21 +49796,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Offset the result set by a specific number of items.", @@ -31281,14 +49834,27 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "rating", "product"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "product", + "rating" + ] + } }, { "description": "Limit result set to reviews from specific category IDs.", @@ -31307,7 +49873,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -31321,21 +49893,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 0 } + "schema": { + "maximum": 100, + "minimum": 0 + } }, { "description": "Limit results to those matching a string.", @@ -31349,28 +49931,47 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Sort ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort by term property.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["name", "slug", "count"] } + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } }, { "description": "If true, empty terms will not be returned.", @@ -31382,7 +49983,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, "description": "OK" } } @@ -31403,12 +50010,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -31417,18 +50035,35 @@ "/wc/store/v1/products/{slug}": { "get": { "parameters": [ - { "description": "Slug of the resource.", "in": "path", "name": "slug", "required": true, "schema": {} }, + { + "description": "Slug of the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -31437,10 +50072,26 @@ "/wc/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v1/coupons": { @@ -31451,21 +50102,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -31479,28 +50140,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -31514,14 +50187,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", @@ -31540,7 +50227,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -31555,8 +50248,15 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "required": true, "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31577,7 +50277,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31602,7 +50308,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -31612,7 +50321,9 @@ "type": "integer" } }, - "required": ["code"], + "required": [ + "code" + ], "type": "object" } } @@ -31620,7 +50331,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -31637,8 +50354,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31659,7 +50382,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31684,7 +50413,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -31701,7 +50433,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -31716,8 +50454,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31738,7 +50482,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31763,7 +50513,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -31780,7 +50533,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -31795,8 +50554,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31817,7 +50582,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31842,7 +50613,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -31859,7 +50633,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -31881,7 +50661,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -31890,7 +50673,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -31909,12 +50698,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -31938,8 +50738,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -31960,7 +50766,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -31985,7 +50797,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -32002,7 +50817,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -32026,8 +50847,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -32048,7 +50875,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -32073,7 +50906,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -32090,7 +50926,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -32114,8 +50956,14 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -32136,7 +50984,13 @@ "description": "List of category IDs the coupon does not apply to.", "type": "array" }, - "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": ["null", "string"] }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] + }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean" @@ -32161,7 +51015,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer" @@ -32178,7 +51035,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -32192,21 +51055,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -32220,14 +51093,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -32241,21 +51122,35 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } + "schema": { + "enum": [ + "id", + "include", + "name", + "registered_date" + ] + } }, { "description": "Limit result set to resources with a specific email.", "in": "query", "name": "email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to resources with a specific role.", @@ -32264,21 +51159,27 @@ "required": false, "schema": { "enum": [ - "all", "administrator", - "editor", + "all", "author", "contributor", - "subscriber", "customer", - "shop_manager" + "editor", + "shop_manager", + "subscriber" ] } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32289,15 +51190,42 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "New user email address.", "required": true, "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "New user password.", "required": true, "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "New user username.", "required": false, "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "New user email address.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "New user password.", + "required": true, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "New user username.", + "required": false, + "type": "string" + } }, - "required": ["email", "password"], + "required": [ + "email", + "password" + ], "type": "object" } } @@ -32305,7 +51233,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32318,13 +51252,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32333,7 +51288,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32344,13 +51305,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32359,7 +51341,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32370,13 +51358,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32385,7 +51394,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32406,12 +51421,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, "description": "OK" } } @@ -32437,7 +51462,10 @@ "description": "Required to be true, as resource does not support binning.", "type": "boolean" }, - "reassign": { "description": "ID to reassign posts to.", "type": "integer" } + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } }, "type": "object" } @@ -32446,7 +51474,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32465,12 +51499,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32490,13 +51535,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32505,7 +51571,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32525,13 +51597,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32540,7 +51633,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32560,13 +51659,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -32575,7 +51695,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -32589,21 +51715,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -32617,28 +51753,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -32652,14 +51800,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", @@ -32676,14 +51838,14 @@ "schema": { "enum": [ "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ] } }, @@ -32711,7 +51873,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32722,27 +51890,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32751,7 +51958,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32764,27 +51977,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32793,7 +52045,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32804,27 +52062,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32833,7 +52130,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32844,27 +52147,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32873,7 +52215,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -32895,7 +52243,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -32904,7 +52255,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32923,12 +52280,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32948,27 +52316,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -32977,7 +52384,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -32997,27 +52410,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -33026,7 +52478,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -33046,27 +52504,66 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -33075,7 +52572,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -33084,25 +52587,48 @@ "/wc/v1/orders/{order_id}/notes": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -33113,9 +52639,15 @@ "description": "Shows/define if the note is only for reference or for the customer (the user will be notified).", "type": "boolean" }, - "note": { "description": "Order note content.", "required": true, "type": "string" } + "note": { + "description": "Order note content.", + "required": true, + "type": "string" + } }, - "required": ["note"], + "required": [ + "note" + ], "type": "object" } } @@ -33123,7 +52655,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -33139,7 +52677,13 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -33158,7 +52702,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -33172,18 +52722,35 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -33192,27 +52759,43 @@ "/wc/v1/orders/{order_id}/refunds": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -33226,28 +52809,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -33261,14 +52856,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", @@ -33285,14 +52894,14 @@ "schema": { "enum": [ "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ] } }, @@ -33320,22 +52929,40 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "amount": { "description": "Refund amount.", "type": "string" }, - "reason": { "description": "Reason for refund.", "type": "string" } + "amount": { + "description": "Refund amount.", + "type": "string" + }, + "reason": { + "description": "Reason for refund.", + "type": "string" + } }, "type": "object" } @@ -33344,7 +52971,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -33353,7 +52986,13 @@ "/wc/v1/orders/{order_id}/refunds/{id}": { "delete": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -33379,14 +53018,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -33399,12 +53050,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -33418,21 +53080,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -33446,28 +53118,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -33481,14 +53165,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", @@ -33509,14 +53207,30 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products assigned a specific category ID.", @@ -33563,7 +53277,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -33574,7 +53294,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -33583,14 +53306,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -33603,47 +53350,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -33652,7 +53474,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -33666,12 +53494,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -33682,16 +53521,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -33699,7 +53553,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -33712,14 +53572,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -33728,7 +53600,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -33739,14 +53617,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -33755,7 +53645,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -33766,14 +53662,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -33782,7 +53690,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -33803,21 +53717,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -33831,14 +53755,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -33852,14 +53784,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -33893,7 +53840,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -33914,15 +53865,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -33931,7 +53894,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -33954,9 +53921,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -33969,7 +53945,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -33989,9 +53971,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34004,7 +53995,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34024,9 +54021,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34039,7 +54045,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34081,7 +54093,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34108,13 +54124,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34142,9 +54167,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34158,7 +54192,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34186,9 +54224,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34202,7 +54249,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34230,9 +54281,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34246,7 +54306,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -34281,7 +54345,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34300,12 +54370,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34325,14 +54406,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -34341,7 +54434,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34361,14 +54460,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -34377,7 +54488,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34397,14 +54514,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -34413,7 +54542,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -34426,7 +54561,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -34435,14 +54573,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -34455,47 +54617,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -34504,7 +54741,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34515,7 +54758,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -34524,14 +54770,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -34544,47 +54814,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -34593,7 +54938,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34604,7 +54955,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -34613,14 +54967,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -34633,47 +55011,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -34682,7 +55135,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34696,21 +55155,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -34724,14 +55193,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -34745,14 +55222,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -34785,7 +55277,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -34796,18 +55294,39 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -34815,7 +55334,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -34828,12 +55353,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34846,7 +55389,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34857,12 +55406,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34875,7 +55442,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34886,12 +55459,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -34904,7 +55495,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -34938,7 +55535,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -34957,12 +55560,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -34982,12 +55596,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35000,7 +55632,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -35020,12 +55658,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35038,7 +55694,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -35058,12 +55720,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35076,7 +55756,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -35090,21 +55776,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -35118,14 +55814,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -35139,14 +55843,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -35180,7 +55899,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35192,14 +55915,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -35208,7 +55940,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35222,8 +55958,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35236,7 +55978,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35247,8 +55995,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35261,7 +56015,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35272,8 +56032,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35286,7 +56052,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35321,7 +56093,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35341,13 +56117,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35368,8 +56153,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35383,7 +56174,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35404,8 +56199,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35419,7 +56220,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35440,8 +56245,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35455,7 +56266,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -35470,21 +56285,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -35498,14 +56323,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -35519,14 +56352,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -35559,7 +56407,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35570,14 +56424,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -35585,7 +56448,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35598,8 +56467,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35612,7 +56487,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35623,8 +56504,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35637,7 +56524,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35648,8 +56541,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35662,7 +56561,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -35696,7 +56601,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35715,12 +56626,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35740,8 +56662,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35754,7 +56682,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35774,8 +56708,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35788,7 +56728,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35808,8 +56754,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -35822,7 +56774,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -35844,7 +56802,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -35853,7 +56814,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -35872,12 +56839,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -35897,7 +56875,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -35906,14 +56887,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -35926,47 +56931,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -35975,7 +57055,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -35995,7 +57081,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -36004,14 +57093,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -36024,47 +57137,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -36073,7 +57261,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -36093,7 +57287,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -36102,14 +57299,38 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, - "date_on_sale_from": { "description": "Start date of sale price.", "type": "string" }, - "date_on_sale_to": { "description": "End data of sale price.", "type": "string" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, + "date_on_sale_from": { + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "type": "string" + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" + }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -36122,47 +57343,122 @@ "description": "Download type, this controls the schema on the front-end.", "type": "string" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "variations": { "description": "List of variations.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "variations": { + "description": "List of variations.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -36171,7 +57467,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -36199,12 +57501,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36226,15 +57539,40 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, - "id": { "description": "Unique identifier for the variation.", "type": "integer" }, - "name": { "description": "Name of the reviewer.", "required": true, "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "Review content.", "required": true, "type": "string" } + "email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "type": "integer" + }, + "name": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + } }, - "required": ["review", "name", "email"], + "required": [ + "email", + "name", + "review" + ], "type": "object" } } @@ -36242,7 +57580,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36271,7 +57615,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -36280,7 +57627,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36306,12 +57659,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36340,12 +57704,27 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -36354,7 +57733,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36383,12 +57768,27 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -36397,7 +57797,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36426,12 +57832,27 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -36440,7 +57861,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -36454,12 +57881,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, "description": "OK" } } @@ -36473,33 +57910,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, "description": "OK" } } @@ -36513,33 +57971,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, "description": "OK" } } @@ -36553,21 +58032,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -36581,26 +58070,49 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { "description": "Sort by tax class.", "in": "query", "name": "class", "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36611,20 +58123,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36633,7 +58175,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36646,20 +58194,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36668,7 +58246,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -36679,20 +58263,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36701,7 +58315,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -36712,20 +58332,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36734,7 +58384,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -36748,12 +58404,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -36763,8 +58430,16 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "name": { "description": "Tax class name.", "required": true, "type": "string" } }, - "required": ["name"], + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], "type": "object" } } @@ -36772,7 +58447,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -36806,7 +58487,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -36840,7 +58527,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36859,12 +58552,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36884,20 +58588,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36906,7 +58640,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36926,20 +58666,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36948,7 +58718,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -36968,20 +58744,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -36990,7 +58796,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -37004,21 +58816,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -37032,28 +58854,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -37067,26 +58901,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "title"] } + "schema": { + "enum": [ + "date", + "id", + "title" + ] + } }, { "description": "Limit result set to webhooks assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37097,16 +58955,33 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "delivery_url": { "description": "Webhook delivery URL.", "required": true, "type": "string" }, - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "delivery_url": { + "description": "Webhook delivery URL.", + "required": true, + "type": "string" + }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "required": true, "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": true, + "type": "string" + } }, - "required": ["topic", "delivery_url"], + "required": [ + "delivery_url", + "topic" + ], "type": "object" } } @@ -37114,7 +58989,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37127,13 +59008,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37142,7 +59032,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37153,13 +59049,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37168,7 +59073,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37179,13 +59090,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37194,7 +59114,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37228,7 +59154,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37247,12 +59179,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37272,13 +59215,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37287,7 +59239,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37307,13 +59265,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37322,7 +59289,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37342,13 +59315,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -37357,7 +59339,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -37378,12 +59366,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, "description": "OK" } } @@ -37411,12 +59410,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, "description": "OK" } } @@ -37425,10 +59435,26 @@ "/wc/v2": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v2/coupons": { @@ -37439,21 +59465,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -37467,28 +59503,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -37502,14 +59546,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -37523,14 +59575,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to resources with a specific code.", @@ -37542,7 +59608,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -37557,16 +59629,29 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "required": true, "type": "string" }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -37603,7 +59688,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -37612,7 +59700,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -37626,7 +59717,9 @@ "type": "integer" } }, - "required": ["code"], + "required": [ + "code" + ], "type": "object" } } @@ -37634,7 +59727,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -37651,16 +59750,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -37697,7 +59808,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -37706,7 +59820,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -37727,7 +59844,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37742,16 +59865,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -37788,7 +59923,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -37797,7 +59935,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -37818,7 +59959,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37833,16 +59980,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -37879,7 +60038,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -37888,7 +60050,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -37909,7 +60074,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -37931,7 +60102,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -37940,7 +60114,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -37959,12 +60139,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -37988,16 +60179,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -38034,7 +60237,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -38043,7 +60249,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -38064,7 +60273,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -38088,16 +60303,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -38134,7 +60361,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -38143,7 +60373,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -38164,7 +60397,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -38188,16 +60427,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -38234,7 +60485,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -38243,7 +60497,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -38264,7 +60521,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -38278,21 +60541,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -38306,14 +60579,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -38327,21 +60608,35 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } + "schema": { + "enum": [ + "id", + "include", + "name", + "registered_date" + ] + } }, { "description": "Limit result set to resources with a specific email.", "in": "query", "name": "email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to resources with a specific role.", @@ -38350,21 +60645,27 @@ "required": false, "schema": { "enum": [ - "all", "administrator", - "editor", + "all", "author", "contributor", - "subscriber", "customer", - "shop_manager" + "editor", + "shop_manager", + "subscriber" ] } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38375,16 +60676,46 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "New user email address.", "required": true, "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "New user password.", "required": true, "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "New user username.", "required": false, "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "New user email address.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "New user password.", + "required": true, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "New user username.", + "required": false, + "type": "string" + } }, - "required": ["email", "password"], + "required": [ + "email", + "password" + ], "type": "object" } } @@ -38392,7 +60723,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38405,14 +60742,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38421,7 +60782,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38432,14 +60799,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38448,7 +60839,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38459,14 +60856,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38475,7 +60896,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38496,12 +60923,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, "description": "OK" } } @@ -38527,7 +60964,10 @@ "description": "Required to be true, as resource does not support binning.", "type": "boolean" }, - "reassign": { "description": "ID to reassign posts to.", "type": "integer" } + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } }, "type": "object" } @@ -38536,7 +60976,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38555,12 +61001,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38580,14 +61037,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38596,7 +61077,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38616,14 +61103,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38632,7 +61143,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38652,14 +61169,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -38668,7 +61209,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -38682,21 +61229,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -38710,28 +61267,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -38745,14 +61310,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -38766,28 +61339,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to orders assigned a specific status.", @@ -38797,16 +61392,16 @@ "schema": { "enum": [ "any", - "trash", "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ] } }, @@ -38843,19 +61438,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -38866,28 +61475,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -38896,7 +61547,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -38909,28 +61566,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -38939,7 +61638,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38950,28 +61655,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -38980,7 +61727,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -38991,28 +61744,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -39021,7 +61816,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -39043,7 +61844,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -39052,7 +61856,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39071,12 +61881,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39096,28 +61917,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -39126,7 +61989,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39146,28 +62015,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -39176,7 +62087,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39196,28 +62113,70 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -39226,7 +62185,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -39235,32 +62200,61 @@ "/wc/v2/orders/{order_id}/notes": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit result to customers or internal notes.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["any", "customer", "internal"] } + "schema": { + "enum": [ + "any", + "customer", + "internal" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -39271,9 +62265,15 @@ "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "type": "boolean" }, - "note": { "description": "Order note content.", "required": true, "type": "string" } + "note": { + "description": "Order note content.", + "required": true, + "type": "string" + } }, - "required": ["note"], + "required": [ + "note" + ], "type": "object" } } @@ -39281,7 +62281,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -39297,7 +62303,13 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -39316,7 +62328,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -39330,18 +62348,35 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -39350,27 +62385,43 @@ "/wc/v2/orders/{order_id}/refunds": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -39384,28 +62435,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -39419,14 +62478,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -39440,28 +62507,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Number of decimal points to use in each resource.", @@ -39482,42 +62571,80 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "amount": { "description": "Refund amount.", "type": "string" }, + "amount": { + "description": "Refund amount.", + "type": "string" + }, "api_refund": { "description": "When true, the payment gateway API is used to generate the refund.", "type": "boolean" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "reason": { "description": "Reason for refund.", "type": "string" }, - "refunded_by": { "description": "User ID of user who created the refund.", "type": "integer" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" } + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "reason": { + "description": "Reason for refund.", + "type": "string" + }, + "refunded_by": { + "description": "User ID of user who created the refund.", + "type": "integer" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + } }, "type": "object" } @@ -39526,7 +62653,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -39535,7 +62668,13 @@ "/wc/v2/orders/{order_id}/refunds/{id}": { "delete": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -39561,14 +62700,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -39581,12 +62732,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -39600,12 +62762,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39626,12 +62799,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39651,11 +62835,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -39664,7 +62863,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39684,11 +62889,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -39697,7 +62917,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39717,11 +62943,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -39730,7 +62971,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -39744,21 +62991,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -39772,28 +63029,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -39807,14 +63072,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -39828,7 +63101,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -39840,14 +63118,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ] } }, @@ -39856,14 +63134,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -39877,14 +63163,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -39968,19 +63271,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -39991,7 +63308,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -40000,28 +63320,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -40030,48 +63380,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -40080,7 +63508,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -40094,12 +63528,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40110,16 +63555,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -40127,7 +63587,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40140,14 +63606,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40156,7 +63634,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40167,14 +63651,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40183,7 +63679,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40194,14 +63696,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40210,7 +63724,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40231,21 +63751,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -40259,14 +63789,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -40280,14 +63818,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -40321,7 +63874,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40342,15 +63899,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -40359,7 +63928,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40382,9 +63955,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40397,7 +63979,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40417,9 +64005,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40432,7 +64029,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40452,9 +64055,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40467,7 +64079,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40509,7 +64127,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40536,13 +64158,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40570,9 +64201,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40586,7 +64226,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40614,9 +64258,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40630,7 +64283,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40658,9 +64315,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -40674,7 +64340,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -40709,7 +64379,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40728,12 +64404,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40753,14 +64440,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40769,7 +64468,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40789,14 +64494,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40805,7 +64522,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40825,14 +64548,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -40841,7 +64576,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -40854,7 +64595,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -40863,28 +64607,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -40893,48 +64667,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -40943,7 +64795,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -40954,7 +64812,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -40963,28 +64824,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -40993,48 +64884,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -41043,7 +65012,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41054,7 +65029,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -41063,28 +65041,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -41093,48 +65101,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -41143,7 +65229,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41157,21 +65249,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -41185,14 +65287,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -41206,14 +65316,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -41246,7 +65371,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41257,18 +65388,39 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -41276,7 +65428,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41289,12 +65447,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41307,7 +65483,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41318,12 +65500,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41336,7 +65536,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41347,12 +65553,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41365,7 +65589,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41399,7 +65629,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41418,12 +65654,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41443,12 +65690,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41461,7 +65726,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41481,12 +65752,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41499,7 +65788,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41519,12 +65814,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41537,7 +65850,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -41551,21 +65870,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -41579,14 +65908,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -41600,14 +65937,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -41641,7 +65993,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41653,14 +66009,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -41669,7 +66034,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41683,8 +66052,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41697,7 +66072,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41708,8 +66089,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41722,7 +66109,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41733,8 +66126,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41747,7 +66146,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -41782,7 +66187,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41802,13 +66211,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41829,8 +66247,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41844,7 +66268,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41865,8 +66293,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41880,7 +66314,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41901,8 +66339,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -41916,7 +66360,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -41931,21 +66379,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -41959,14 +66417,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -41980,14 +66446,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -42020,7 +66501,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42031,14 +66518,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -42046,7 +66542,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42059,8 +66561,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42073,7 +66581,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42084,8 +66598,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42098,7 +66618,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42109,8 +66635,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42123,7 +66655,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42157,7 +66695,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42176,12 +66720,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42201,8 +66756,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42215,7 +66776,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42235,8 +66802,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42249,7 +66822,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42269,8 +66848,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -42283,7 +66868,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -42305,7 +66896,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -42314,7 +66908,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42333,12 +66933,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42358,7 +66969,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -42367,28 +66981,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -42397,48 +67041,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -42447,7 +67169,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42467,7 +67195,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -42476,28 +67207,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -42506,48 +67267,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -42556,7 +67395,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42576,7 +67421,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -42585,28 +67433,58 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -42615,48 +67493,126 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "grouped_products": { "description": "List of grouped products ID.", "type": "array" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "type": "array" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -42665,7 +67621,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -42693,12 +67655,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -42720,19 +67693,47 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, - "id": { "description": "Unique identifier for the variation.", "type": "integer" }, - "name": { "description": "Name of the reviewer.", "required": true, "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "Review content.", "required": true, "type": "string" } + "email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "type": "integer" + }, + "name": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + } }, - "required": ["review", "name", "email"], + "required": [ + "email", + "name", + "review" + ], "type": "object" } } @@ -42740,7 +67741,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -42764,16 +67771,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -42782,7 +67807,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42804,16 +67835,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -42822,7 +67871,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42844,16 +67899,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -42862,7 +67935,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -42891,7 +67970,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -42900,7 +67982,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -42926,12 +68014,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -42960,16 +68059,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -42978,7 +68095,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -43007,16 +68130,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -43025,7 +68166,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -43054,16 +68201,34 @@ "properties": { "date_created": { "description": "The date the review was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, - "email": { "description": "Reviewer email.", "type": "string" }, - "name": { "description": "Reviewer name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" } + "email": { + "description": "Reviewer email.", + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + } }, "type": "object" } @@ -43072,7 +68237,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -43093,21 +68264,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -43121,28 +68302,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -43156,14 +68345,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -43177,28 +68374,51 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -43212,14 +68432,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -43303,19 +68540,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43335,29 +68586,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43366,32 +68638,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43400,7 +68722,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43422,29 +68750,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43453,32 +68802,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43487,7 +68886,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -43507,29 +68912,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43538,32 +68964,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43572,7 +69048,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -43592,29 +69074,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43623,32 +69126,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43657,7 +69210,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -43686,7 +69245,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -43695,7 +69257,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43721,12 +69289,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43753,29 +69332,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43784,32 +69384,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43818,7 +69468,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43845,29 +69501,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43876,32 +69553,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -43910,7 +69637,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -43937,29 +69670,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -43968,32 +69722,82 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Unique identifier.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Unique identifier.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -44002,7 +69806,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -44016,12 +69826,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, "description": "OK" } } @@ -44035,33 +69855,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, "description": "OK" } } @@ -44075,33 +69916,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, "description": "OK" } } @@ -44111,7 +69973,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting_group" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting_group" + } + } + }, "description": "OK" } } @@ -44120,12 +69988,30 @@ "/wc/v2/settings/{group_id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44133,16 +70019,35 @@ }, "/wc/v2/settings/{group_id}/batch": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44152,22 +70057,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44177,22 +70107,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44202,7 +70157,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -44211,7 +70172,13 @@ "/wc/v2/settings/{group_id}/{id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -44219,11 +70186,23 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44237,17 +70216,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44257,7 +70253,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44271,17 +70273,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44291,7 +70310,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44305,17 +70330,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44325,7 +70367,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -44335,7 +70383,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -44346,10 +70400,19 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "required": true, "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -44357,7 +70420,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -44366,14 +70435,23 @@ "/wc/v2/shipping/zones/{id}": { "delete": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -44382,33 +70460,63 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -44417,22 +70525,40 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -44441,22 +70567,40 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -44465,7 +70609,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -44474,12 +70624,22 @@ "/wc/v2/shipping/zones/{id}/locations": { "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -44487,15 +70647,27 @@ }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -44505,7 +70677,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -44513,15 +70689,27 @@ }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -44531,7 +70719,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -44539,15 +70731,27 @@ }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -44557,7 +70761,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -44567,30 +70775,62 @@ "/wc/v2/shipping/zones/{zone_id}/methods": { "get": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} } + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} } + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "method_id": { "description": "Shipping method ID.", "required": true }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "method_id": { + "description": "Shipping method ID.", + "required": true + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, - "required": ["method_id"], + "required": [ + "method_id" + ], "type": "object" } } @@ -44598,7 +70838,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } @@ -44607,7 +70853,13 @@ "/wc/v2/shipping/zones/{zone_id}/methods/{instance_id}": { "delete": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44621,7 +70873,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -44630,14 +70885,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44648,14 +70915,26 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44669,9 +70948,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -44680,14 +70968,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44701,9 +71001,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -44712,14 +71021,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -44733,9 +71054,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -44744,7 +71074,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } @@ -44758,12 +71094,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, "description": "OK" } } @@ -44784,12 +71130,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, "description": "OK" } } @@ -44803,12 +71159,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status" + } + } + }, "description": "OK" } } @@ -44822,12 +71188,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44846,7 +71223,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44866,11 +71249,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -44879,7 +71277,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44899,11 +71303,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -44912,7 +71331,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44932,11 +71357,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -44945,7 +71385,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -44959,21 +71405,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -44987,26 +71443,49 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { "description": "Sort by tax class.", "in": "query", "name": "class", "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45017,20 +71496,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45039,7 +71548,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45052,20 +71567,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45074,7 +71619,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45085,20 +71636,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45107,7 +71688,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45118,20 +71705,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45140,7 +71757,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45154,12 +71777,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -45169,8 +71803,16 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "name": { "description": "Tax class name.", "required": true, "type": "string" } }, - "required": ["name"], + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], "type": "object" } } @@ -45178,7 +71820,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -45212,7 +71860,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -45229,7 +71883,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -45263,7 +71923,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45282,12 +71948,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45307,20 +71984,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45329,7 +72036,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45349,20 +72062,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45371,7 +72114,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45391,20 +72140,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "city": { "description": "City name.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, - "postcode": { "description": "Postcode / ZIP.", "type": "string" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "city": { + "description": "City name.", + "type": "string" + }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -45413,7 +72192,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -45427,21 +72212,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -45455,28 +72250,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -45490,26 +72297,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "title"] } + "schema": { + "enum": [ + "date", + "id", + "title" + ] + } }, { "description": "Limit result set to webhooks assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45520,16 +72351,33 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "delivery_url": { "description": "Webhook delivery URL.", "required": true, "type": "string" }, - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "delivery_url": { + "description": "Webhook delivery URL.", + "required": true, + "type": "string" + }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "required": true, "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": true, + "type": "string" + } }, - "required": ["topic", "delivery_url"], + "required": [ + "delivery_url", + "topic" + ], "type": "object" } } @@ -45537,7 +72385,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45550,13 +72404,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45565,7 +72428,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45576,13 +72445,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45591,7 +72469,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45602,13 +72486,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45617,7 +72510,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -45651,7 +72550,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45670,12 +72575,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45695,13 +72611,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45710,7 +72635,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45730,13 +72661,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45745,7 +72685,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45765,13 +72711,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -45780,7 +72735,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -45801,12 +72762,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, "description": "OK" } } @@ -45834,12 +72806,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, "description": "OK" } } @@ -45848,10 +72831,26 @@ "/wc/v3": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/coupons": { @@ -45862,21 +72861,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -45890,28 +72899,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -45925,14 +72942,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -45946,14 +72971,28 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to resources with a specific code.", @@ -45965,7 +73004,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -45980,16 +73025,29 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "required": true, "type": "string" }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46026,7 +73084,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46035,7 +73096,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46049,7 +73113,9 @@ "type": "integer" } }, - "required": ["code"], + "required": [ + "code" + ], "type": "object" } } @@ -46057,7 +73123,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46074,16 +73146,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46120,7 +73204,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46129,7 +73216,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46150,7 +73240,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46165,16 +73261,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46211,7 +73319,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46220,7 +73331,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46241,7 +73355,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46256,16 +73376,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46302,7 +73434,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46311,7 +73446,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46332,7 +73470,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46354,7 +73498,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -46363,7 +73510,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46382,12 +73535,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46411,16 +73575,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46457,7 +73633,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46466,7 +73645,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46487,7 +73669,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46511,16 +73699,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46557,7 +73757,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46566,7 +73769,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46587,7 +73793,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46611,16 +73823,28 @@ "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string" }, - "code": { "description": "Coupon code.", "type": "string" }, + "code": { + "description": "Coupon code.", + "type": "string" + }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" }, - "description": { "description": "Coupon description.", "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string" @@ -46657,7 +73881,10 @@ "description": "Maximum order amount allowed when using the coupon.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string" @@ -46666,7 +73893,10 @@ "description": "List of category IDs the coupon applies to.", "type": "array" }, - "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array" }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "type": "array" + }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string" @@ -46687,7 +73917,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, "description": "OK" } } @@ -46701,21 +73937,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -46729,14 +73975,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -46750,21 +74004,35 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } + "schema": { + "enum": [ + "id", + "include", + "name", + "registered_date" + ] + } }, { "description": "Limit result set to resources with a specific email.", "in": "query", "name": "email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to resources with a specific role.", @@ -46773,21 +74041,27 @@ "required": false, "schema": { "enum": [ - "all", "administrator", - "editor", + "all", "author", "contributor", - "subscriber", "customer", - "shop_manager" + "editor", + "shop_manager", + "subscriber" ] } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -46798,16 +74072,46 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "New user email address.", "required": true, "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "New user password.", "required": true, "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "New user username.", "required": false, "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "New user email address.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "New user password.", + "required": true, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "New user username.", + "required": false, + "type": "string" + } }, - "required": ["email", "password"], + "required": [ + "email", + "password" + ], "type": "object" } } @@ -46815,7 +74119,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -46828,14 +74138,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -46844,7 +74178,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46855,14 +74195,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -46871,7 +74235,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46882,14 +74252,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -46898,7 +74292,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -46919,12 +74319,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, "description": "OK" } } @@ -46950,7 +74360,10 @@ "description": "Required to be true, as resource does not support binning.", "type": "boolean" }, - "reassign": { "description": "ID to reassign posts to.", "type": "integer" } + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } }, "type": "object" } @@ -46959,7 +74372,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -46978,12 +74397,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -47003,14 +74433,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -47019,7 +74473,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -47039,14 +74499,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -47055,7 +74539,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -47075,14 +74565,38 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "List of billing address data.", "type": "object" }, - "email": { "description": "The email address for the customer.", "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string" }, - "last_name": { "description": "Customer last name.", "type": "string" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "password": { "description": "Customer password.", "type": "string" }, - "shipping": { "description": "List of shipping address data.", "type": "object" }, - "username": { "description": "Customer login name.", "type": "string" } + "billing": { + "description": "List of billing address data.", + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "type": "string" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "password": { + "description": "Customer password.", + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "type": "object" + }, + "username": { + "description": "Customer login name.", + "type": "string" + } }, "type": "object" } @@ -47091,7 +74605,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, "description": "OK" } } @@ -47101,7 +74621,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, "description": "OK" } } @@ -47111,7 +74637,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_continents" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_continents" + } + } + }, "description": "OK" } } @@ -47127,11 +74659,23 @@ "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "location", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "location", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_continents" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_continents" + } + } + }, "description": "OK" } } @@ -47141,7 +74685,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -47160,7 +74710,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, "description": "OK" } } @@ -47170,7 +74726,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, "description": "OK" } } @@ -47180,7 +74742,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, "description": "OK" } } @@ -47196,11 +74764,23 @@ "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "currency", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "currency", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, "description": "OK" } } @@ -47217,7 +74797,11 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/layout-templates/{id}": { @@ -47231,7 +74815,11 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/marketplace/create-order": { @@ -47240,33 +74828,78 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "product_id": { "required": true } }, - "required": ["product_id"], + "properties": { + "product_id": { + "required": true + } + }, + "required": [ + "product_id" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/featured": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/refresh": { + "post": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/subscriptions": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/wc/v3/marketplace/featured": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wc/v3/marketplace/refresh": { "post": { "responses": { "200": { "description": "OK" } } } }, - "/wc/v3/marketplace/subscriptions": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wc/v3/marketplace/subscriptions/activate": { "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "product_key": { "required": true, "type": "string" } }, - "required": ["product_key"], + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/marketplace/subscriptions/connect": { @@ -47275,14 +74908,25 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "product_key": { "required": true, "type": "string" } }, - "required": ["product_key"], + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/marketplace/subscriptions/disconnect": { @@ -47291,20 +74935,43 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "product_key": { "required": true, "type": "string" } }, - "required": ["product_key"], + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/marketplace/subscriptions/install-url": { "get": { - "parameters": [{ "description": "", "in": "query", "name": "product_key", "required": true, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "query", + "name": "product_key", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/orders": { @@ -47315,21 +74982,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -47343,28 +75020,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -47378,14 +75063,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -47399,28 +75092,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to orders which have specific statuses.", @@ -47431,16 +75146,16 @@ "items": { "enum": [ "any", - "trash", "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" } @@ -47479,19 +75194,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47502,32 +75231,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47536,7 +75307,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47549,32 +75326,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47583,7 +75402,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -47594,32 +75419,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47628,7 +75495,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -47639,32 +75512,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47673,7 +75588,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -47695,7 +75616,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -47704,7 +75628,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47723,12 +75653,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47748,32 +75689,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47782,7 +75765,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47802,32 +75791,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47836,7 +75867,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47856,32 +75893,74 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "billing": { "description": "Billing address.", "type": "object" }, - "coupon_lines": { "description": "Coupons line data.", "type": "array" }, + "billing": { + "description": "Billing address.", + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "type": "array" + }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string" }, - "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer" }, - "customer_note": { "description": "Note left by customer during checkout.", "type": "string" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "line_items": { "description": "Line items data.", "type": "array" }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "type": "array" + }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "parent_id": { "description": "Parent order ID.", "type": "integer" }, - "payment_method": { "description": "Payment method ID.", "type": "string" }, - "payment_method_title": { "description": "Payment method title.", "type": "string" }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "type": "string" + }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean" }, - "shipping": { "description": "Shipping address.", "type": "object" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" }, - "status": { "description": "Order status.", "type": "string" }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string" } + "shipping": { + "description": "Shipping address.", + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + }, + "status": { + "description": "Order status.", + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "type": "string" + } }, "type": "object" } @@ -47890,7 +75969,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, "description": "OK" } } @@ -47907,7 +75992,11 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "parameters": [ @@ -47924,7 +76013,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "expiration_date": { "description": "Expiration date formatted as dd-mm-yyyy.", "type": "string" }, + "expiration_date": { + "description": "Expiration date formatted as dd-mm-yyyy.", + "type": "string" + }, "expiration_days": { "description": "Number of days to be added to the current date to get the expiration date.", "type": "integer" @@ -47940,38 +76032,71 @@ } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/orders/{order_id}/notes": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Limit result to customers or internal notes.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["any", "customer", "internal"] } + "schema": { + "enum": [ + "any", + "customer", + "internal" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -47986,9 +76111,15 @@ "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "type": "boolean" }, - "note": { "description": "Order note content.", "required": true, "type": "string" } + "note": { + "description": "Order note content.", + "required": true, + "type": "string" + } }, - "required": ["note"], + "required": [ + "note" + ], "type": "object" } } @@ -47996,7 +76127,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -48012,7 +76149,13 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -48031,7 +76174,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -48045,18 +76194,35 @@ "required": true, "schema": {} }, - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, "description": "OK" } } @@ -48065,27 +76231,43 @@ "/wc/v3/orders/{order_id}/refunds": { "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -48099,28 +76281,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -48134,14 +76324,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -48155,28 +76353,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Number of decimal points to use in each resource.", @@ -48197,43 +76417,84 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} } + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "amount": { "description": "Refund amount.", "type": "string" }, + "amount": { + "description": "Refund amount.", + "type": "string" + }, "api_refund": { "description": "When true, the payment gateway API is used to generate the refund.", "type": "boolean" }, - "api_restock": { "description": "When true, refunded items are restocked.", "type": "boolean" }, - "fee_lines": { "description": "Fee lines data.", "type": "array" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "reason": { "description": "Reason for refund.", "type": "string" }, - "refunded_by": { "description": "User ID of user who created the refund.", "type": "integer" }, - "shipping_lines": { "description": "Shipping lines data.", "type": "array" } + "api_restock": { + "description": "When true, refunded items are restocked.", + "type": "boolean" + }, + "fee_lines": { + "description": "Fee lines data.", + "type": "array" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "reason": { + "description": "Reason for refund.", + "type": "string" + }, + "refunded_by": { + "description": "User ID of user who created the refund.", + "type": "integer" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "type": "array" + } }, "type": "object" } @@ -48242,7 +76503,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -48251,7 +76518,13 @@ "/wc/v3/orders/{order_id}/refunds/{id}": { "delete": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -48277,14 +76550,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The order ID.", "in": "path", "name": "order_id", "required": true, "schema": {} }, + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -48297,12 +76582,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -48316,12 +76612,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48342,12 +76649,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48367,11 +76685,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -48380,7 +76713,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48400,11 +76739,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -48413,7 +76767,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48433,11 +76793,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Payment gateway description on checkout.", "type": "string" }, - "enabled": { "description": "Payment gateway enabled status.", "type": "boolean" }, - "order": { "description": "Payment gateway sort order.", "type": "integer" }, - "settings": { "description": "Payment gateway settings.", "type": "object" }, - "title": { "description": "Payment gateway title on checkout.", "type": "string" } + "description": { + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "order": { + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "type": "string" + } }, "type": "object" } @@ -48446,7 +76821,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, "description": "OK" } } @@ -48460,21 +76841,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -48488,28 +76879,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -48523,14 +76922,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -48544,7 +76951,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -48556,17 +76968,17 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", - "rating", - "menu_order", + "popularity", "price", - "popularity", - "rating" + "rating", + "rating", + "rating", + "slug", + "title" ] } }, @@ -48575,14 +76987,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -48596,14 +77016,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -48680,21 +77117,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit results to those with a SKU that partially matches a string.", @@ -48706,7 +77157,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -48717,7 +77174,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -48726,36 +77186,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -48764,50 +77260,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -48816,7 +77399,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -48830,12 +77419,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -48846,16 +77446,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -48863,7 +77478,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -48876,14 +77497,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -48892,7 +77525,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -48903,14 +77542,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -48919,7 +77570,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -48930,14 +77587,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -48946,7 +77615,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -48967,21 +77642,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -48995,14 +77680,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -49016,14 +77709,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -49057,7 +77765,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49078,15 +77790,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -49095,7 +77819,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49118,9 +77846,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49133,7 +77870,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49153,9 +77896,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49168,7 +77920,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49188,9 +77946,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49203,7 +77970,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49245,7 +78018,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49272,13 +78049,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49306,9 +78092,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49322,7 +78117,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49350,9 +78149,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49366,7 +78174,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49394,9 +78206,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Term name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Term name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -49410,7 +78231,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } }, "description": "OK" } @@ -49445,7 +78270,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49464,12 +78295,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49489,14 +78331,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -49505,7 +78359,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49525,14 +78385,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -49541,7 +78413,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49561,14 +78439,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "has_archives": { "description": "Enable/Disable attribute archives.", "type": "boolean" }, - "name": { "description": "Attribute name.", "type": "string" }, - "order_by": { "description": "Default sort order.", "type": "string" }, + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" }, - "type": { "description": "Type of attribute.", "type": "string" } + "type": { + "description": "Type of attribute.", + "type": "string" + } }, "type": "object" } @@ -49577,7 +78467,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, "description": "OK" } } @@ -49590,7 +78486,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -49599,36 +78498,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -49637,50 +78572,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -49689,7 +78711,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49700,7 +78728,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -49709,36 +78740,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -49747,50 +78814,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -49799,7 +78953,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49810,7 +78970,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -49819,36 +78982,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -49857,50 +79056,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -49909,7 +79195,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -49923,21 +79215,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -49951,14 +79253,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -49972,14 +79282,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -50012,7 +79337,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50023,18 +79354,39 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -50042,7 +79394,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50055,12 +79413,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50073,7 +79449,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50084,12 +79466,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50102,7 +79502,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50113,12 +79519,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50131,7 +79555,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50165,7 +79595,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50184,12 +79620,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50209,12 +79656,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50227,7 +79692,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50247,12 +79718,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50265,7 +79754,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50285,12 +79780,30 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "display": { "description": "Category archive display type.", "type": "string" }, - "image": { "description": "Image data.", "type": "object" }, - "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer" }, - "name": { "description": "Category name.", "type": "string" }, - "parent": { "description": "The ID for the parent of the resource.", "type": "integer" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "type": "string" + }, + "image": { + "description": "Image data.", + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "description": "Category name.", + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50303,7 +79816,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -50324,14 +79843,19 @@ "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -50345,10 +79869,19 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v3/products/reviews": { @@ -50359,21 +79892,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -50387,28 +79930,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to reviews published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -50422,54 +79977,95 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "product"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ] + } }, { "description": "Limit result set to reviews assigned to specific user IDs.", "in": "query", "name": "reviewer", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes reviews assigned to specific user IDs.", "in": "query", "name": "reviewer_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to that from a specific author email.", "in": "query", "name": "reviewer_email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit result set to reviews assigned to specific product IDs.", "in": "query", "name": "product", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to reviews assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "hold", "approved", "spam", "trash"] } + "schema": { + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50485,14 +80081,40 @@ "required": true, "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "Review content.", "required": true, "type": "string" }, - "reviewer": { "description": "Name of the reviewer.", "required": true, "type": "string" }, - "reviewer_email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + }, + "reviewer": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "reviewer_email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, - "required": ["product_id", "reviewer", "reviewer_email", "review"], + "required": [ + "product_id", + "review", + "reviewer", + "reviewer_email" + ], "type": "object" } } @@ -50500,7 +80122,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50517,12 +80145,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50531,7 +80177,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50546,12 +80198,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50560,7 +80230,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50575,12 +80251,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50589,7 +80283,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50611,7 +80311,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -50620,7 +80323,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50639,12 +80348,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50668,12 +80388,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50682,7 +80420,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50706,12 +80450,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50720,7 +80482,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50744,12 +80512,30 @@ "description": "Unique identifier for the product that the review belongs to.", "type": "integer" }, - "product_name": { "description": "Product name.", "type": "string" }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer" }, - "review": { "description": "The content of the review.", "type": "string" }, - "reviewer": { "description": "Reviewer name.", "type": "string" }, - "reviewer_email": { "description": "Reviewer email.", "type": "string" }, - "status": { "description": "Status of the review.", "type": "string" } + "product_name": { + "description": "Product name.", + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "type": "string" + }, + "status": { + "description": "Status of the review.", + "type": "string" + } }, "type": "object" } @@ -50758,7 +80544,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, "description": "OK" } } @@ -50772,21 +80564,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -50800,14 +80602,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -50821,14 +80631,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -50862,7 +80687,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -50874,14 +80703,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -50890,7 +80728,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -50904,8 +80746,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50918,7 +80766,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50929,8 +80783,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50943,7 +80803,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50954,8 +80820,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -50968,7 +80840,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -50977,7 +80855,13 @@ "/wc/v3/products/shipping_classes/slug-suggestion": { "get": { "parameters": [ - { "description": "Shipping class name.", "in": "query", "name": "name", "required": false, "schema": {} }, + { + "description": "Shipping class name.", + "in": "query", + "name": "name", + "required": false, + "schema": {} + }, { "description": "An alphanumeric identifier for the resource unique to its type.", "in": "query", @@ -50996,7 +80880,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51032,7 +80920,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51052,13 +80944,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51079,8 +80980,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51094,7 +81001,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51115,8 +81026,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51130,7 +81047,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51151,8 +81072,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Shipping class name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51166,7 +81093,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } }, "description": "OK" } @@ -51181,21 +81112,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -51209,28 +81150,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -51244,14 +81193,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -51265,7 +81222,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -51277,14 +81239,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ] } }, @@ -51293,14 +81255,22 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -51314,14 +81284,31 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products assigned a specific type.", "in": "query", "name": "type", "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -51405,28 +81392,44 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to specific product categorie ids.", "in": "query", "name": "categories", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific product tag ids.", "in": "query", "name": "tags", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific amount of suggested products.", @@ -51438,7 +81441,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -51452,21 +81461,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -51480,14 +81499,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", @@ -51501,14 +81528,29 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by resource attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } }, { "description": "Whether to hide resources not assigned to any products.", @@ -51541,7 +81583,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51552,14 +81600,23 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Name for the resource.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -51567,7 +81624,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51580,8 +81643,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51594,7 +81663,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -51605,8 +81680,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51619,7 +81700,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -51630,8 +81717,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51644,7 +81737,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -51678,7 +81777,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51697,12 +81802,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51722,8 +81838,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51736,7 +81858,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51756,8 +81884,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51770,7 +81904,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51790,8 +81930,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the resource.", "type": "string" }, - "name": { "description": "Tag name.", "type": "string" }, + "description": { + "description": "HTML description of the resource.", + "type": "string" + }, + "name": { + "description": "Tag name.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string" @@ -51804,7 +81950,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -51826,7 +81978,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -51835,7 +81990,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -51854,12 +82015,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -51879,7 +82051,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -51888,36 +82063,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -51926,50 +82137,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -51978,7 +82276,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -51998,7 +82302,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -52007,36 +82314,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52045,50 +82388,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52097,7 +82527,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -52117,7 +82553,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -52126,36 +82565,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52164,50 +82639,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52216,7 +82778,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -52238,7 +82806,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" @@ -52247,36 +82818,72 @@ "description": "Product external button text. Only for external products.", "type": "string" }, - "catalog_visibility": { "description": "Catalogue visibility.", "type": "string" }, - "categories": { "description": "List of categories.", "type": "array" }, - "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array" }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "type": "string" + }, + "categories": { + "description": "List of categories.", + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "type": "array" + }, "date_created": { "description": "The date the product was created, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "type": "array" + }, + "description": { + "description": "Product description.", + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "type": "object" }, - "default_attributes": { "description": "Defaults variation attributes.", "type": "array" }, - "description": { "description": "Product description.", "type": "string" }, - "dimensions": { "description": "Product dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52285,50 +82892,137 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the product is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, + "downloadable": { + "description": "If the product is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string" }, - "featured": { "description": "Featured product.", "type": "boolean" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "images": { "description": "List of images.", "type": "array" }, + "featured": { + "description": "Featured product.", + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "images": { + "description": "List of images.", + "type": "array" + }, "low_stock_amount": { "description": "Low Stock amount for the product.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "name": { + "description": "Product name.", + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "type": "string" }, - "manage_stock": { "description": "Stock management at product level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "name": { "description": "Product name.", "type": "string" }, - "parent_id": { "description": "Product parent ID.", "type": "integer" }, - "post_password": { "description": "Post password.", "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string" }, - "regular_price": { "description": "Product regular price.", "type": "string" }, - "reviews_allowed": { "description": "Allow reviews.", "type": "boolean" }, - "sale_price": { "description": "Product sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "short_description": { "description": "Product short description.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "slug": { "description": "Product slug.", "type": "string" }, + "regular_price": { + "description": "Product regular price.", + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "slug": { + "description": "Product slug.", + "type": "string" + }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean" }, - "status": { "description": "Product status (post status).", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tags": { "description": "List of tags.", "type": "array" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "type": { "description": "Product type.", "type": "string" }, - "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array" }, - "virtual": { "description": "If the product is virtual.", "type": "boolean" }, - "weight": { "description": "Product weight (kg).", "type": "string" } + "status": { + "description": "Product status (post status).", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tags": { + "description": "List of tags.", + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "type": { + "description": "Product type.", + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52337,7 +83031,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -52358,21 +83058,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -52386,28 +83096,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -52421,14 +83139,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -52442,28 +83168,51 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to products with a specific slug.", @@ -52477,7 +83226,17 @@ "in": "query", "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", @@ -52512,21 +83271,35 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to products with specified stock status.", "in": "query", "name": "stock_status", "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { "description": "Limit result set to products with or without price.", @@ -52543,9 +83316,18 @@ "schema": { "items": { "properties": { - "attribute": { "description": "Attribute slug.", "type": "string" }, - "term": { "description": "Attribute term.", "type": "string" }, - "terms": { "description": "Attribute terms.", "type": "array" } + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } }, "type": "object" } @@ -52554,7 +83336,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -52574,29 +83362,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52605,28 +83414,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52635,7 +83501,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -52657,29 +83529,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52688,28 +83581,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52718,7 +83668,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -52738,29 +83694,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52769,28 +83746,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52799,7 +83833,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -52819,29 +83859,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52850,28 +83911,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52880,7 +83998,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -52902,31 +84026,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_values": { + "description": "Default values for generated variations.", + "type": "object" + }, + "delete": { + "description": "Deletes unused variations.", + "type": "boolean" + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "default_values": { "description": "Default values for generated variations.", "type": "object" }, - "delete": { "description": "Deletes unused variations.", "type": "boolean" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -52935,28 +84086,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -52965,7 +84173,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -52994,7 +84208,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -53003,7 +84220,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53029,12 +84252,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53061,29 +84295,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -53092,28 +84347,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -53122,7 +84434,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53149,29 +84467,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -53180,28 +84519,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -53210,7 +84606,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53237,29 +84639,50 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "List of attributes.", "type": "array" }, + "attributes": { + "description": "List of attributes.", + "type": "array" + }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, - "description": { "description": "Variation description.", "type": "string" }, - "dimensions": { "description": "Variation dimensions.", "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer" @@ -53268,28 +84691,85 @@ "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, - "downloadable": { "description": "If the variation is downloadable.", "type": "boolean" }, - "downloads": { "description": "List of downloadable files.", "type": "array" }, - "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, - "image": { "description": "Variation image data.", "type": "object" }, + "downloadable": { + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "type": "string" + }, + "image": { + "description": "Variation image data.", + "type": "object" + }, "low_stock_amount": { "description": "Low Stock amount for the variation.", - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, - "manage_stock": { "description": "Stock management at variation level.", "type": "boolean" }, - "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer" }, - "meta_data": { "description": "Meta data.", "type": "array" }, - "regular_price": { "description": "Variation regular price.", "type": "string" }, - "sale_price": { "description": "Variation sale price.", "type": "string" }, - "shipping_class": { "description": "Shipping class slug.", "type": "string" }, - "sku": { "description": "Stock Keeping Unit.", "type": "string" }, - "status": { "description": "Variation status.", "type": "string" }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer" }, - "stock_status": { "description": "Controls the stock status of the product.", "type": "string" }, - "tax_class": { "description": "Tax class.", "type": "string" }, - "tax_status": { "description": "Tax status.", "type": "string" }, - "virtual": { "description": "If the variation is virtual.", "type": "boolean" }, - "weight": { "description": "Variation weight (kg).", "type": "string" } + "manage_stock": { + "description": "Stock management at variation level.", + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "type": "array" + }, + "regular_price": { + "description": "Variation regular price.", + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "type": "string" + }, + "status": { + "description": "Variation status.", + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } }, "type": "object" } @@ -53298,7 +84778,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, "description": "OK" } } @@ -53312,21 +84798,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -53340,28 +84836,36 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", @@ -53375,14 +84879,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -53396,28 +84908,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ] + } }, { "description": "Limit result set to those of particular parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Number of decimal points to use in each resource.", @@ -53438,19 +84972,33 @@ "in": "query", "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Ensure meta_data excludes specific keys.", "in": "query", "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, "description": "OK" } } @@ -53464,12 +85012,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, "description": "OK" } } @@ -53483,12 +85041,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupon_total" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupon_total" + } + } + }, "description": "OK" } } @@ -53502,13 +85070,21 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customer_total" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customer_total" + } + } }, "description": "OK" } @@ -53523,12 +85099,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_order_total" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_order_total" + } + } + }, "description": "OK" } } @@ -53542,12 +85128,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_product_total" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_product_total" + } + } + }, "description": "OK" } } @@ -53561,12 +85157,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_review_total" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_review_total" + } + } + }, "description": "OK" } } @@ -53580,33 +85186,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, "description": "OK" } } @@ -53620,33 +85247,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Report period.", "in": "query", "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_min", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } }, { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "in": "query", "name": "date_max", "required": false, - "schema": { "format": "date" } + "schema": { + "format": "date" + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, "description": "OK" } } @@ -53656,7 +85304,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting_group" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting_group" + } + } + }, "description": "OK" } } @@ -53666,7 +85320,13 @@ "patch": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -53674,7 +85334,13 @@ "post": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -53682,7 +85348,13 @@ "put": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -53691,12 +85363,30 @@ "/wc/v3/settings/{group_id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53704,16 +85394,35 @@ }, "/wc/v3/settings/{group_id}/batch": { "patch": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53723,22 +85432,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53748,22 +85482,47 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53773,7 +85532,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -53782,7 +85547,13 @@ "/wc/v3/settings/{group_id}/{id}": { "get": { "parameters": [ - { "description": "Settings group ID.", "in": "query", "name": "group", "required": false, "schema": {} }, + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, { "description": "Unique identifier for the resource.", "in": "path", @@ -53790,11 +85561,23 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53808,17 +85591,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53828,7 +85628,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53842,17 +85648,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53862,7 +85685,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53876,17 +85705,34 @@ "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "group_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "group": { "description": "Settings group ID.", "type": "string" }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { "description": "Setting value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53896,7 +85742,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, "description": "OK" } } @@ -53906,7 +85758,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -53917,10 +85775,19 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "required": true, "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -53928,7 +85795,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -53937,14 +85810,23 @@ "/wc/v3/shipping/zones/{id}": { "delete": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -53953,33 +85835,63 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -53988,22 +85900,40 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -54012,22 +85942,40 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "Shipping zone name.", "type": "string" }, - "order": { "description": "Shipping zone order.", "type": "integer" } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, "type": "object" } @@ -54036,7 +85984,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, "description": "OK" } } @@ -54045,12 +85999,22 @@ "/wc/v3/shipping/zones/{id}/locations": { "get": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -54058,15 +86022,27 @@ }, "patch": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -54076,7 +86052,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -54084,15 +86064,27 @@ }, "post": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -54102,7 +86094,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -54110,15 +86106,27 @@ }, "put": { "parameters": [ - { "description": "Unique ID for the resource.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "code": { "description": "Shipping zone location code.", "type": "string" }, - "type": { "description": "Shipping zone location type.", "type": "string" } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } }, "type": "object" } @@ -54128,7 +86136,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } }, "description": "OK" } @@ -54138,30 +86150,62 @@ "/wc/v3/shipping/zones/{zone_id}/methods": { "get": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} } + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} } + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "method_id": { "description": "Shipping method ID.", "required": true }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "method_id": { + "description": "Shipping method ID.", + "required": true + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, - "required": ["method_id"], + "required": [ + "method_id" + ], "type": "object" } } @@ -54169,7 +86213,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } @@ -54178,7 +86228,13 @@ "/wc/v3/shipping/zones/{zone_id}/methods/{instance_id}": { "delete": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54192,7 +86248,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -54201,14 +86260,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54219,14 +86290,26 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54240,9 +86323,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -54251,14 +86343,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54272,9 +86376,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -54283,14 +86396,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "Unique ID for the zone.", "in": "path", "name": "zone_id", "required": true, "schema": {} }, + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, { "description": "Unique ID for the instance.", "in": "path", @@ -54304,9 +86429,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "enabled": { "description": "Shipping method enabled status.", "type": "boolean" }, - "order": { "description": "Shipping method sort order.", "type": "integer" }, - "settings": { "description": "Shipping method settings.", "type": "object" } + "enabled": { + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "order": { + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "type": "object" + } }, "type": "object" } @@ -54315,7 +86449,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, "description": "OK" } } @@ -54329,12 +86469,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, "description": "OK" } } @@ -54355,12 +86505,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, "description": "OK" } } @@ -54374,12 +86534,22 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status" + } + } + }, "description": "OK" } } @@ -54393,12 +86563,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54417,7 +86598,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54437,11 +86624,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -54450,7 +86652,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54470,11 +86678,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -54483,7 +86706,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54503,11 +86732,26 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "action": { "description": "What running the tool will do.", "type": "string" }, - "description": { "description": "Tool description.", "type": "string" }, - "message": { "description": "Tool return message.", "type": "string" }, - "name": { "description": "Tool name.", "type": "string" }, - "success": { "description": "Did the tool run successfully?", "type": "boolean" } + "action": { + "description": "What running the tool will do.", + "type": "string" + }, + "description": { + "description": "Tool description.", + "type": "string" + }, + "message": { + "description": "Tool return message.", + "type": "string" + }, + "name": { + "description": "Tool name.", + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "type": "boolean" + } }, "type": "object" } @@ -54516,7 +86760,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, "description": "OK" } } @@ -54530,21 +86780,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -54558,26 +86818,49 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { "description": "Sort by tax class.", "in": "query", "name": "class", "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54588,16 +86871,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54606,13 +86907,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54621,7 +86931,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54634,16 +86950,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54652,13 +86986,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54667,7 +87010,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -54678,16 +87027,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54696,13 +87063,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54711,7 +87087,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -54722,16 +87104,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54740,13 +87140,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54755,7 +87164,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -54769,12 +87184,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -54784,8 +87210,16 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "name": { "description": "Tax class name.", "required": true, "type": "string" } }, - "required": ["name"], + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], "type": "object" } } @@ -54793,7 +87227,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -54827,7 +87267,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -54844,7 +87290,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, "description": "OK" } } @@ -54878,7 +87330,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54897,12 +87355,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54922,16 +87391,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54940,13 +87427,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -54955,7 +87451,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -54975,16 +87477,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -54993,13 +87513,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -55008,7 +87537,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -55028,16 +87563,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array" }, + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" + }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string" }, - "class": { "description": "Tax class.", "type": "string" }, - "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean" }, - "country": { "description": "Country ISO 3166 code.", "type": "string" }, - "name": { "description": "Tax rate name.", "type": "string" }, - "order": { "description": "Indicates the order that will appear in queries.", "type": "integer" }, + "class": { + "description": "Tax class.", + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string" @@ -55046,13 +87599,22 @@ "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "type": "array" }, - "priority": { "description": "Tax priority.", "type": "integer" }, - "rate": { "description": "Tax rate.", "type": "string" }, + "priority": { + "description": "Tax priority.", + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "type": "string" + }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean" }, - "state": { "description": "State code.", "type": "string" } + "state": { + "description": "State code.", + "type": "string" + } }, "type": "object" } @@ -55061,7 +87623,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, "description": "OK" } } @@ -55075,21 +87643,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -55103,28 +87681,40 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to resources published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific ids.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -55138,26 +87728,50 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "title"] } + "schema": { + "enum": [ + "date", + "id", + "title" + ] + } }, { "description": "Limit result set to webhooks assigned a specific status.", "in": "query", "name": "status", "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55168,16 +87782,33 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "delivery_url": { "description": "Webhook delivery URL.", "required": true, "type": "string" }, - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "delivery_url": { + "description": "Webhook delivery URL.", + "required": true, + "type": "string" + }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "required": true, "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": true, + "type": "string" + } }, - "required": ["topic", "delivery_url"], + "required": [ + "delivery_url", + "topic" + ], "type": "object" } } @@ -55185,7 +87816,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55198,13 +87835,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55213,7 +87859,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -55224,13 +87876,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55239,7 +87900,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -55250,13 +87917,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55265,7 +87941,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, "description": "OK" } } @@ -55299,7 +87981,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55318,12 +88006,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55343,13 +88042,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55358,7 +88066,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55378,13 +88092,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55393,7 +88116,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55413,13 +88142,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "name": { "description": "A friendly name for the webhook.", "type": "string" }, + "name": { + "description": "A friendly name for the webhook.", + "type": "string" + }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string" }, - "status": { "description": "Webhook status.", "type": "string" }, - "topic": { "description": "Webhook topic.", "type": "string" } + "status": { + "description": "Webhook status.", + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "type": "string" + } }, "type": "object" } @@ -55428,7 +88166,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, "description": "OK" } } @@ -55437,10 +88181,26 @@ "/wccom-site/v3": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wccom-site/v3/installer": { @@ -55450,17 +88210,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" }, - "run-until-step": { "required": true, "type": "string" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + }, + "run-until-step": { + "required": true, + "type": "string" + } }, - "required": ["product-id", "run-until-step", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id", + "run-until-step" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -55468,17 +88245,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" }, - "run-until-step": { "required": true, "type": "string" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + }, + "run-until-step": { + "required": true, + "type": "string" + } }, - "required": ["product-id", "run-until-step", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id", + "run-until-step" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -55486,17 +88280,34 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" }, - "run-until-step": { "required": true, "type": "string" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + }, + "run-until-step": { + "required": true, + "type": "string" + } }, - "required": ["product-id", "run-until-step", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id", + "run-until-step" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wccom-site/v3/installer/reset": { @@ -55506,16 +88317,29 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + } }, - "required": ["product-id", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "post": { "requestBody": { @@ -55523,16 +88347,29 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + } }, - "required": ["product-id", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } }, "put": { "requestBody": { @@ -55540,35 +88377,94 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "idempotency-key": { "required": true, "type": "string" }, - "product-id": { "required": true, "type": "integer" } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + } }, - "required": ["product-id", "idempotency-key"], + "required": [ + "idempotency-key", + "product-id" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wccom-site/v3/ssr": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wccom-site/v3/status": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/wccom-site/v3/ssr": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wccom-site/v3/status": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wp-block-editor/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp-block-editor/v1/export": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/wp-block-editor/v1/export": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wp-block-editor/v1/navigation-fallback": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/navigation-fallback" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/navigation-fallback" + } + } + }, "description": "OK" } } @@ -55582,42 +88478,106 @@ "in": "query", "name": "url", "required": true, - "schema": { "format": "uri" } + "schema": { + "format": "uri" + } } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp-openapi/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp-openapi/v1/schema": { "get": { - "parameters": [{ "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }], - "responses": { "200": { "description": "OK" } } + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp-site-health/v1": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/directory-sizes": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } } }, - "/wp-site-health/v1/directory-sizes": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wp-site-health/v1/tests/authorization-header": { "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, "description": "OK" } } @@ -55627,7 +88587,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, "description": "OK" } } @@ -55637,7 +88603,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, "description": "OK" } } @@ -55647,7 +88619,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, "description": "OK" } } @@ -55657,20 +88635,50 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/tests/page-cache": { + "get": { + "responses": { + "200": { "description": "OK" } } } }, - "/wp-site-health/v1/tests/page-cache": { "get": { "responses": { "200": { "description": "OK" } } } }, "/wp/v2": { "get": { "parameters": [ - { "description": "", "in": "query", "name": "namespace", "required": false, "schema": {} }, - { "description": "", "in": "query", "name": "context", "required": false, "schema": {} } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/block-directory/search": { @@ -55681,33 +88689,50 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit result set to blocks matching the search term.", "in": "query", "name": "term", "required": true, - "schema": { "minLength": 1 } + "schema": { + "minLength": 1 + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-directory-item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-directory-item" + } + } + }, "description": "OK" } } @@ -55718,7 +88743,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/block-pattern-category" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-pattern-category" + } + } }, "description": "OK" } @@ -55729,7 +88758,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-pattern" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-pattern" + } + } + }, "description": "OK" } } @@ -55750,7 +88785,11 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["edit"] } + "schema": { + "enum": [ + "edit" + ] + } }, { "description": "Attributes for the block.", @@ -55769,7 +88808,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rendered-block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rendered-block" + } + } + }, "description": "OK" } } @@ -55789,12 +88834,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "attributes": { "description": "Attributes for the block.", "type": "object" }, + "attributes": { + "description": "Attributes for the block.", + "type": "object" + }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "post_id": { "description": "ID of the post context.", "type": "integer" } + "post_id": { + "description": "ID of the post context.", + "type": "integer" + } }, "type": "object" } @@ -55803,7 +88854,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rendered-block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rendered-block" + } + } + }, "description": "OK" } } @@ -55817,13 +88874,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "Block namespace.", "in": "query", "name": "namespace", "required": false, "schema": {} } + { + "description": "Block namespace.", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, "description": "OK" } } @@ -55837,13 +88912,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "Block namespace.", "in": "path", "name": "namespace", "required": true, "schema": {} } + { + "description": "Block namespace.", + "in": "path", + "name": "namespace", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, "description": "OK" } } @@ -55852,19 +88945,43 @@ "/wp/v2/block-types/{namespace}/{name}": { "get": { "parameters": [ - { "description": "Block name.", "in": "path", "name": "name", "required": true, "schema": {} }, - { "description": "Block namespace.", "in": "path", "name": "namespace", "required": true, "schema": {} }, + { + "description": "Block name.", + "in": "path", + "name": "name", + "required": true, + "schema": {} + }, + { + "description": "Block namespace.", + "in": "path", + "name": "namespace", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, "description": "OK" } } @@ -55878,21 +88995,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -55906,42 +89034,58 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -55955,7 +89099,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -55968,11 +89117,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ] } @@ -55982,14 +89131,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -55999,27 +89161,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -56030,7 +89192,12 @@ "in": "query", "name": "tax_relation", "required": false, - "schema": { "enum": ["AND", "OR"] } + "schema": { + "enum": [ + "AND", + "OR" + ] + } }, { "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", @@ -56041,7 +89208,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -56052,13 +89221,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -56077,7 +89251,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -56088,7 +89264,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -56101,7 +89279,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56112,14 +89296,32 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56128,9 +89330,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56143,7 +89354,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56165,7 +89382,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -56174,7 +89394,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56193,7 +89419,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Override the default excerpt length.", @@ -56212,7 +89444,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56232,14 +89470,32 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56248,9 +89504,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56263,7 +89528,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56283,14 +89554,32 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56299,9 +89588,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56314,7 +89612,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56334,14 +89638,32 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56350,9 +89672,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56365,7 +89696,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, "description": "OK" } } @@ -56386,33 +89723,80 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the autosave.", "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -56421,9 +89805,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "type": "array" @@ -56436,7 +89829,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56452,18 +89851,36 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56484,21 +89901,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -56512,14 +89940,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -56533,19 +89969,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56586,7 +90043,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56612,12 +90075,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, "description": "OK" } } @@ -56631,21 +90106,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -56659,21 +90145,34 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -56681,7 +90180,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -56710,12 +90218,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56726,16 +90244,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -56743,7 +90276,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56765,7 +90304,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -56774,7 +90316,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56793,12 +90341,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56818,10 +90378,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -56834,7 +90406,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56854,10 +90432,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -56870,7 +90460,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56890,10 +90486,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -56906,7 +90514,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, "description": "OK" } } @@ -56920,21 +90534,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -56948,49 +90573,71 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result set to comments assigned to specific user IDs. Requires authorisation.", "in": "query", "name": "author", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.", "in": "query", "name": "author_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to that from a specific author email. Requires authorisation.", "in": "query", "name": "author_email", "required": false, - "schema": { "format": "email" } + "schema": { + "format": "email" + } }, { "description": "Limit response to comments published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -57004,35 +90651,62 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by comment attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "post", "parent", "type"] } + "schema": { + "enum": [ + "date", + "date_gmt", + "id", + "include", + "parent", + "post", + "type" + ] + } }, { "description": "Limit result set to comments of specific parent IDs.", "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes specific parent IDs.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to comments assigned to specific post IDs.", "in": "query", "name": "post", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to comments assigned a specific status. Requires authorisation.", @@ -57058,7 +90732,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57069,22 +90749,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID of the user object, if author was a user.", "type": "integer" }, - "author_email": { "description": "Email address for the comment author.", "type": "string" }, - "author_ip": { "description": "IP address for the comment author.", "type": "string" }, - "author_name": { "description": "Display name for the comment author.", "type": "string" }, - "author_url": { "description": "URL for the comment author.", "type": "string" }, - "author_user_agent": { "description": "User agent for the comment author.", "type": "string" }, - "content": { "description": "The content for the comment.", "type": "object" }, + "author": { + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "type": "object" + }, "date": { "description": "The date the comment was published, in the site's time zone.", "type": "string" }, - "date_gmt": { "description": "The date the comment was published, as GMT.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the comment.", "type": "integer" }, - "post": { "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "description": "State of the comment.", "type": "string" } + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "type": "string" + } }, "type": "object" } @@ -57093,7 +90809,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57115,7 +90837,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" }, + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + }, "password": { "description": "The password for the parent post of the comment (if the post is password protected).", "type": "string" @@ -57128,7 +90853,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57147,7 +90878,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "The password for the parent post of the comment (if the post is password protected).", @@ -57159,7 +90896,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57179,22 +90922,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID of the user object, if author was a user.", "type": "integer" }, - "author_email": { "description": "Email address for the comment author.", "type": "string" }, - "author_ip": { "description": "IP address for the comment author.", "type": "string" }, - "author_name": { "description": "Display name for the comment author.", "type": "string" }, - "author_url": { "description": "URL for the comment author.", "type": "string" }, - "author_user_agent": { "description": "User agent for the comment author.", "type": "string" }, - "content": { "description": "The content for the comment.", "type": "object" }, + "author": { + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "type": "object" + }, "date": { "description": "The date the comment was published, in the site's time zone.", "type": "string" }, - "date_gmt": { "description": "The date the comment was published, as GMT.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the comment.", "type": "integer" }, - "post": { "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "description": "State of the comment.", "type": "string" } + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "type": "string" + } }, "type": "object" } @@ -57203,7 +90982,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57223,22 +91008,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID of the user object, if author was a user.", "type": "integer" }, - "author_email": { "description": "Email address for the comment author.", "type": "string" }, - "author_ip": { "description": "IP address for the comment author.", "type": "string" }, - "author_name": { "description": "Display name for the comment author.", "type": "string" }, - "author_url": { "description": "URL for the comment author.", "type": "string" }, - "author_user_agent": { "description": "User agent for the comment author.", "type": "string" }, - "content": { "description": "The content for the comment.", "type": "object" }, + "author": { + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "type": "object" + }, "date": { "description": "The date the comment was published, in the site's time zone.", "type": "string" }, - "date_gmt": { "description": "The date the comment was published, as GMT.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the comment.", "type": "integer" }, - "post": { "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "description": "State of the comment.", "type": "string" } + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "type": "string" + } }, "type": "object" } @@ -57247,7 +91068,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57267,22 +91094,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID of the user object, if author was a user.", "type": "integer" }, - "author_email": { "description": "Email address for the comment author.", "type": "string" }, - "author_ip": { "description": "IP address for the comment author.", "type": "string" }, - "author_name": { "description": "Display name for the comment author.", "type": "string" }, - "author_url": { "description": "URL for the comment author.", "type": "string" }, - "author_user_agent": { "description": "User agent for the comment author.", "type": "string" }, - "content": { "description": "The content for the comment.", "type": "object" }, + "author": { + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "type": "object" + }, "date": { "description": "The date the comment was published, in the site's time zone.", "type": "string" }, - "date_gmt": { "description": "The date the comment was published, as GMT.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the comment.", "type": "integer" }, - "post": { "description": "The ID of the associated post object.", "type": "integer" }, - "status": { "description": "State of the comment.", "type": "string" } + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "type": "string" + } }, "type": "object" } @@ -57291,7 +91154,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, "description": "OK" } } @@ -57305,26 +91174,43 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/font-collection" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/font-collection" + } + } + }, "description": "OK" } } @@ -57338,13 +91224,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "slug", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/font-collection" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/font-collection" + } + } + }, "description": "OK" } } @@ -57358,35 +91262,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -57400,26 +91323,46 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include"] } + "schema": { + "enum": [ + "id", + "include" + ] + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57440,7 +91383,9 @@ "type": "integer" } }, - "required": ["font_family_settings"], + "required": [ + "font_family_settings" + ], "type": "object" } } @@ -57448,7 +91393,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57469,35 +91420,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -57511,19 +91481,35 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include"] } + "schema": { + "enum": [ + "id", + "include" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, "description": "OK" } } @@ -57553,7 +91539,9 @@ "type": "integer" } }, - "required": ["font_face_settings"], + "required": [ + "font_face_settings" + ], "type": "object" } } @@ -57561,7 +91549,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, "description": "OK" } } @@ -57590,7 +91584,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -57599,7 +91596,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, "description": "OK" } } @@ -57625,12 +91628,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, "description": "OK" } } @@ -57652,7 +91667,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -57661,7 +91679,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57680,12 +91704,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57715,7 +91751,9 @@ "type": "integer" } }, - "required": ["font_family_settings"], + "required": [ + "font_family_settings" + ], "type": "object" } } @@ -57723,7 +91761,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57753,7 +91797,9 @@ "type": "integer" } }, - "required": ["font_family_settings"], + "required": [ + "font_family_settings" + ], "type": "object" } } @@ -57761,7 +91807,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57791,7 +91843,9 @@ "type": "integer" } }, - "required": ["font_family_settings"], + "required": [ + "font_family_settings" + ], "type": "object" } } @@ -57799,7 +91853,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, "description": "OK" } } @@ -57808,41 +91868,97 @@ "/wp/v2/global-styles/themes/{stylesheet}": { "get": { "parameters": [ - { "description": "The theme identifier", "in": "path", "name": "stylesheet", "required": true, "schema": {} } + { + "description": "The theme identifier", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/global-styles/themes/{stylesheet}/variations": { "get": { "parameters": [ - { "description": "The theme identifier", "in": "path", "name": "stylesheet", "required": true, "schema": {} } + { + "description": "The theme identifier", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/global-styles/{id}": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, "description": "OK" } } }, "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "settings": { "description": "Global settings.", "type": ["object"] }, - "styles": { "description": "Global styles.", "type": ["object"] }, - "title": { "description": "Title of the global styles variation.", "type": ["object", "string"] } + "settings": { + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "description": "Global styles.", + "type": [ + "object" + ] + }, + "title": { + "description": "Title of the global styles variation.", + "type": [ + "object", + "string" + ] + } }, "type": "object" } @@ -57851,21 +91967,51 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "settings": { "description": "Global settings.", "type": ["object"] }, - "styles": { "description": "Global styles.", "type": ["object"] }, - "title": { "description": "Title of the global styles variation.", "type": ["object", "string"] } + "settings": { + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "description": "Global styles.", + "type": [ + "object" + ] + }, + "title": { + "description": "Title of the global styles variation.", + "type": [ + "object", + "string" + ] + } }, "type": "object" } @@ -57874,21 +92020,51 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "settings": { "description": "Global settings.", "type": ["object"] }, - "styles": { "description": "Global styles.", "type": ["object"] }, - "title": { "description": "Title of the global styles variation.", "type": ["object", "string"] } + "settings": { + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "description": "Global styles.", + "type": [ + "object" + ] + }, + "title": { + "description": "Title of the global styles variation.", + "type": [ + "object", + "string" + ] + } }, "type": "object" } @@ -57897,7 +92073,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, "description": "OK" } } @@ -57918,21 +92100,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Offset the result set by a specific number of items.", @@ -57945,7 +92138,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles-revision" + } + } }, "description": "OK" } @@ -57974,13 +92171,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles-revision" + } + } }, "description": "OK" } @@ -57995,21 +92202,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -58023,56 +92241,80 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result set to posts assigned to specific authors.", "in": "query", "name": "author", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes posts assigned to specific authors.", "in": "query", "name": "author_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -58086,7 +92328,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -58099,11 +92346,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ] } @@ -58113,42 +92360,78 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Array of column names to be searched.", "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", "in": "query", "name": "status", "required": false, - "schema": { "items": { "enum": ["inherit", "private", "trash"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "inherit", + "private", + "trash" + ], + "type": "string" + } + } }, { "description": "Limit result set to attachments of a particular media type.", "in": "query", "name": "media_type", "required": false, - "schema": { "enum": ["image", "video", "application"] } + "schema": { + "enum": [ + "application", + "image", + "video" + ] + } }, { "description": "Limit result set to attachments of a particular MIME type.", @@ -58160,7 +92443,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58175,29 +92464,68 @@ "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, - "author": { "description": "The ID for the author of the post.", "type": "integer" }, - "caption": { "description": "The attachment caption.", "type": "object" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "description": "The attachment caption.", + "type": "object" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "The attachment description.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, + "post": { + "description": "The ID for the associated post of the attachment.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "description": { "description": "The attachment description.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, - "post": { "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -58206,7 +92534,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58228,7 +92562,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -58237,7 +92574,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58256,12 +92599,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58285,29 +92640,68 @@ "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, - "author": { "description": "The ID for the author of the post.", "type": "integer" }, - "caption": { "description": "The attachment caption.", "type": "object" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "description": "The attachment caption.", + "type": "object" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "The attachment description.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, + "post": { + "description": "The ID for the associated post of the attachment.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "description": { "description": "The attachment description.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, - "post": { "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -58316,7 +92710,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58340,29 +92740,68 @@ "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, - "author": { "description": "The ID for the author of the post.", "type": "integer" }, - "caption": { "description": "The attachment caption.", "type": "object" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "description": "The attachment caption.", + "type": "object" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "The attachment description.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, + "post": { + "description": "The ID for the associated post of the attachment.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "description": { "description": "The attachment description.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, - "post": { "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -58371,7 +92810,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58395,29 +92840,68 @@ "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, - "author": { "description": "The ID for the author of the post.", "type": "integer" }, - "caption": { "description": "The attachment caption.", "type": "object" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "description": "The attachment caption.", + "type": "object" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "The attachment description.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, + "post": { + "description": "The ID for the associated post of the attachment.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "description": { "description": "The attachment description.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, - "post": { "description": "The ID for the associated post of the attachment.", "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -58426,7 +92910,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, "description": "OK" } } @@ -58434,7 +92924,15 @@ }, "/wp/v2/media/{id}/edit": { "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -58444,12 +92942,19 @@ "description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead.", "type": "number" }, - "modifiers": { "description": "Array of image edits.", "type": "array" }, + "modifiers": { + "description": "Array of image edits.", + "type": "array" + }, "rotation": { "description": "The amount to rotate the image clockwise in degrees. DEPRECATED: use `modifiers` instead.", "type": "integer" }, - "src": { "description": "URL to the edited image file.", "required": true, "type": "string" }, + "src": { + "description": "URL to the edited image file.", + "required": true, + "type": "string" + }, "width": { "description": "As a percentage of the image, the width to which to crop the image. DEPRECATED: use `modifiers` instead.", "type": "number" @@ -58463,13 +92968,19 @@ "type": "number" } }, - "required": ["src"], + "required": [ + "src" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/media/{id}/post-process": { @@ -58487,14 +92998,25 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "action": { "required": true, "type": "string" } }, - "required": ["action"], + "properties": { + "action": { + "required": true, + "type": "string" + } + }, + "required": [ + "action" + ], "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/menu-items": { @@ -58505,21 +93027,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -58533,42 +93066,58 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -58582,7 +93131,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", @@ -58595,13 +93149,13 @@ "date", "id", "include", + "include_slugs", + "menu_order", "modified", "parent", "relevance", "slug", - "include_slugs", - "title", - "menu_order" + "title" ] } }, @@ -58610,14 +93164,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -58627,27 +93194,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -58658,7 +93225,12 @@ "in": "query", "name": "tax_relation", "required": false, - "schema": { "enum": ["AND", "OR"] } + "schema": { + "enum": [ + "AND", + "OR" + ] + } }, { "description": "Limit result set to items with specific terms assigned in the menus taxonomy.", @@ -58669,7 +93241,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -58680,13 +93254,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -58705,7 +93284,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -58716,7 +93297,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -58736,7 +93319,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58751,8 +93340,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -58761,7 +93356,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -58770,18 +93368,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -58794,7 +93407,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58816,7 +93435,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -58825,7 +93447,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58844,12 +93472,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58873,8 +93513,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -58883,7 +93529,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -58892,18 +93541,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -58916,7 +93580,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -58940,8 +93610,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -58950,7 +93626,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -58959,18 +93638,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -58983,7 +93677,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -59007,8 +93707,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -59017,7 +93723,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -59026,18 +93735,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -59050,7 +93774,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, "description": "OK" } } @@ -59071,21 +93801,45 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -59095,8 +93849,14 @@ "description": "Text for the title attribute of the link element for this menu item.", "type": "string" }, - "classes": { "description": "Class names for the link element of this menu item.", "type": "array" }, - "description": { "description": "The description of this menu item.", "type": "string" }, + "classes": { + "description": "Class names for the link element of this menu item.", + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "type": "string" + }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "type": "integer" @@ -59105,7 +93865,10 @@ "description": "The terms assigned to the object in the nav_menu taxonomy.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "type": "string" @@ -59114,18 +93877,33 @@ "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "type": "integer" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "target": { "description": "The target attribute of the link element for this menu item.", "type": "string" }, - "title": { "description": "The title for the object.", "type": ["string", "object"] }, + "title": { + "description": "The title for the object.", + "type": [ + "object", + "string" + ] + }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "type": "string" }, - "url": { "description": "The URL to which this menu item points.", "type": "string" }, + "url": { + "description": "The URL to which this menu item points.", + "type": "string" + }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "type": "array" @@ -59139,7 +93917,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } }, "description": "OK" } @@ -59156,19 +93938,35 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } }, "description": "OK" } @@ -59183,12 +93981,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/menu-location" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/menu-location" + } + } + }, "description": "OK" } } @@ -59209,12 +94019,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/menu-location" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/menu-location" + } + } + }, "description": "OK" } } @@ -59228,21 +94050,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -59256,14 +94089,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -59277,7 +94118,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -59285,7 +94131,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -59307,12 +94162,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59327,16 +94192,31 @@ "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, - "description": { "description": "HTML description of the term.", "type": "string" }, - "locations": { "description": "The locations assigned to the menu.", "type": "array" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "locations": { + "description": "The locations assigned to the menu.", + "type": "array" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -59344,7 +94224,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59366,7 +94252,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -59375,7 +94264,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59394,12 +94289,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59423,10 +94330,22 @@ "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, - "description": { "description": "HTML description of the term.", "type": "string" }, - "locations": { "description": "The locations assigned to the menu.", "type": "array" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "locations": { + "description": "The locations assigned to the menu.", + "type": "array" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -59439,7 +94358,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59463,10 +94388,22 @@ "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, - "description": { "description": "HTML description of the term.", "type": "string" }, - "locations": { "description": "The locations assigned to the menu.", "type": "array" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "locations": { + "description": "The locations assigned to the menu.", + "type": "array" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -59479,7 +94416,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59503,10 +94446,22 @@ "description": "Whether to automatically add top-level pages to this menu.", "type": "boolean" }, - "description": { "description": "HTML description of the term.", "type": "string" }, - "locations": { "description": "The locations assigned to the menu.", "type": "array" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "locations": { + "description": "The locations assigned to the menu.", + "type": "array" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -59519,7 +94474,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, "description": "OK" } } @@ -59533,21 +94494,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -59561,42 +94533,58 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -59610,7 +94598,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -59623,11 +94616,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ] } @@ -59637,14 +94630,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -59654,27 +94660,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -59683,7 +94689,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59694,12 +94706,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59708,9 +94732,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59719,7 +94752,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59741,7 +94780,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -59750,7 +94792,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59769,7 +94817,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "The password for the post if it is password protected.", @@ -59781,7 +94835,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59801,12 +94861,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59815,9 +94887,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59826,7 +94907,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59846,12 +94933,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59860,9 +94959,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59871,7 +94979,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59891,12 +95005,24 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59905,9 +95031,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59916,7 +95051,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, "description": "OK" } } @@ -59937,33 +95078,72 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "parent": { "description": "The ID for the parent of the autosave.", "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -59972,9 +95152,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -59984,7 +95173,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60001,19 +95194,35 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60035,21 +95244,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -60063,14 +95283,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -60084,20 +95312,39 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60140,7 +95387,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60167,13 +95418,23 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } }, "description": "OK" } @@ -60188,21 +95449,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -60216,56 +95488,80 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result set to posts assigned to specific authors.", "in": "query", "name": "author", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes posts assigned to specific authors.", "in": "query", "name": "author_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to posts with a specific menu_order value.", @@ -60286,7 +95582,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -60299,13 +95600,13 @@ "date", "id", "include", + "include_slugs", + "menu_order", "modified", "parent", "relevance", "slug", - "include_slugs", - "title", - "menu_order" + "title" ] } }, @@ -60314,28 +95615,49 @@ "in": "query", "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to all items except those of a particular parent ID.", "in": "query", "name": "parent_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Array of column names to be searched.", "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -60345,27 +95667,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -60374,7 +95696,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60385,37 +95713,76 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60424,7 +95791,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60446,7 +95819,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -60455,7 +95831,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60474,7 +95856,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Override the default excerpt length.", @@ -60493,7 +95881,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60513,37 +95907,76 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60552,7 +95985,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60572,37 +96011,76 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60611,7 +96089,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60631,37 +96115,76 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60670,7 +96193,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, "description": "OK" } } @@ -60691,55 +96220,120 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the object.", "type": "integer" }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "type": "integer" + }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -60748,7 +96342,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60764,18 +96364,36 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60796,21 +96414,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -60824,14 +96453,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -60845,19 +96482,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60898,7 +96556,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60924,12 +96588,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, "description": "OK" } } @@ -60943,42 +96619,59 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", "in": "query", "name": "search", "required": false, - "schema": { "minLength": 1 } + "schema": { + "minLength": 1 + } }, { "description": "Limit results to those matching a category ID.", "in": "query", "name": "category", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Limit results to those matching a keyword ID.", "in": "query", "name": "keyword", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Limit results to those matching a pattern (slug).", @@ -60999,7 +96692,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -61010,15 +96708,15 @@ "enum": [ "author", "date", + "favorite_count", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", - "title", - "favorite_count" + "title" ] } } @@ -61026,7 +96724,11 @@ "responses": { "200": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/pattern-directory-item" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/pattern-directory-item" + } + } }, "description": "OK" } @@ -61041,7 +96743,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Limit results to those matching a string.", @@ -61055,12 +96763,26 @@ "in": "query", "name": "status", "required": false, - "schema": { "items": { "enum": ["inactive", "active"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } @@ -61071,10 +96793,19 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "slug": { "description": "WordPress.org plugin directory slug.", "required": true, "type": "string" }, - "status": { "description": "The plugin activation status.", "type": "string" } + "slug": { + "description": "WordPress.org plugin directory slug.", + "required": true, + "type": "string" + }, + "status": { + "description": "The plugin activation status.", + "type": "string" + } }, - "required": ["slug"], + "required": [ + "slug" + ], "type": "object" } } @@ -61082,7 +96813,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } @@ -61090,7 +96827,15 @@ }, "/wp/v2/plugins/{plugin}": { "delete": { - "parameters": [{ "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -61108,7 +96853,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } @@ -61120,19 +96871,45 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } }, "patch": { - "parameters": [{ "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -61142,7 +96919,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "status": { "description": "The plugin activation status.", "type": "string" } + "status": { + "description": "The plugin activation status.", + "type": "string" + } }, "type": "object" } @@ -61151,13 +96931,27 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -61167,7 +96961,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "status": { "description": "The plugin activation status.", "type": "string" } + "status": { + "description": "The plugin activation status.", + "type": "string" + } }, "type": "object" } @@ -61176,13 +96973,27 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "plugin", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -61192,7 +97003,10 @@ "description": "Scope under which the request is made; determines fields present in response.", "type": "string" }, - "status": { "description": "The plugin activation status.", "type": "string" } + "status": { + "description": "The plugin activation status.", + "type": "string" + } }, "type": "object" } @@ -61201,7 +97015,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, "description": "OK" } } @@ -61215,21 +97035,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -61243,56 +97074,80 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit result set to posts assigned to specific authors.", "in": "query", "name": "author", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Ensure result set excludes posts assigned to specific authors.", "in": "query", "name": "author_exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -61306,7 +97161,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -61319,11 +97179,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ] } @@ -61333,14 +97193,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -61350,27 +97223,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -61381,7 +97254,12 @@ "in": "query", "name": "tax_relation", "required": false, - "schema": { "enum": ["AND", "OR"] } + "schema": { + "enum": [ + "AND", + "OR" + ] + } }, { "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", @@ -61392,7 +97270,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -61408,13 +97288,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -61433,7 +97318,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -61449,7 +97336,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -61468,7 +97357,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -61479,13 +97370,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -61504,7 +97400,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -61515,7 +97413,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -61535,7 +97435,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61546,7 +97452,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61555,26 +97464,56 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61583,8 +97522,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61593,7 +97538,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61615,7 +97566,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -61624,7 +97578,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61643,7 +97603,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Override the default excerpt length.", @@ -61662,7 +97628,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61682,7 +97654,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61691,26 +97666,56 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61719,8 +97724,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61729,7 +97740,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61749,7 +97766,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61758,26 +97778,56 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61786,8 +97836,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61796,7 +97852,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61816,7 +97878,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61825,26 +97890,56 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61853,8 +97948,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61863,7 +97964,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, "description": "OK" } } @@ -61884,25 +97991,54 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the post.", "type": "integer" }, + "author": { + "description": "The ID for the author of the post.", + "type": "integer" + }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array" @@ -61911,27 +98047,60 @@ "description": "Whether or not comments are open on the post.", "type": "string" }, - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "format": { "description": "The format for the post.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the autosave.", "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, - "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string" }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, + "status": { + "description": "A named status for the object.", + "type": "string" + }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" @@ -61940,8 +98109,14 @@ "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -61950,7 +98125,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -61966,18 +98147,36 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -61998,21 +98197,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -62026,14 +98236,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -62047,19 +98265,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -62100,7 +98339,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -62126,12 +98371,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, "description": "OK" } } @@ -62145,21 +98402,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -62173,42 +98441,58 @@ "in": "query", "name": "after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "in": "query", "name": "modified_after", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts published before a given ISO8601 compliant date.", "in": "query", "name": "before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "in": "query", "name": "modified_before", "required": false, - "schema": { "format": "date-time" } + "schema": { + "format": "date-time" + } }, { "description": "Ensure result set excludes specific IDs.", "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -62222,7 +98506,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by post attribute.", @@ -62235,16 +98524,16 @@ "date", "id", "include", + "include_slugs", "modified", "parent", - "relevance", - "slug", - "include_slugs", - "title", + "popularity", "popularity", "rating", - "popularity", - "rating" + "rating", + "relevance", + "slug", + "title" ] } }, @@ -62253,14 +98542,27 @@ "in": "query", "name": "search_columns", "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + } + } }, { "description": "Limit result set to posts with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to posts assigned one or more statuses.", @@ -62270,27 +98572,27 @@ "schema": { "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" } @@ -62301,7 +98603,12 @@ "in": "query", "name": "tax_relation", "required": false, - "schema": { "enum": ["AND", "OR"] } + "schema": { + "enum": [ + "AND", + "OR" + ] + } }, { "description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.", @@ -62312,7 +98619,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -62328,13 +98637,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -62353,7 +98667,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -62369,7 +98685,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -62388,7 +98706,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -62399,13 +98719,18 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -62424,7 +98749,9 @@ "oneOf": [ { "description": "Match terms with the listed IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "title": "Term ID List", "type": "array" }, @@ -62435,7 +98762,9 @@ "terms": { "default": [], "description": "Term IDs.", - "items": { "type": "integer" }, + "items": { + "type": "integer" + }, "type": "array" } }, @@ -62448,7 +98777,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62459,15 +98794,36 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62484,9 +98840,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62495,7 +98860,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62517,7 +98888,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -62526,7 +98900,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62545,7 +98925,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Override the default excerpt length.", @@ -62564,7 +98950,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62584,15 +98976,36 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62609,9 +99022,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62620,7 +99042,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62640,15 +99068,36 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62665,9 +99114,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62676,7 +99134,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62696,15 +99160,36 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62721,9 +99206,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62732,7 +99226,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, "description": "OK" } } @@ -62753,34 +99253,84 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "content": { "description": "The content for the post.", "type": "object" }, + "content": { + "description": "The content for the post.", + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "type": "integer" }, - "date_gmt": { "description": "The date the post was published, as GMT.", "type": ["string", "null"] }, - "excerpt": { "description": "The excerpt for the post.", "type": "object" }, - "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "parent": { "description": "The ID for the parent of the autosave.", "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" @@ -62797,9 +99347,18 @@ "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, - "status": { "description": "A named status for the object.", "type": "string" }, - "template": { "description": "The theme file to use to display the post.", "type": "string" }, - "title": { "description": "The title for the post.", "type": "object" } + "status": { + "description": "A named status for the object.", + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "description": "The title for the post.", + "type": "object" + } }, "type": "object" } @@ -62808,7 +99367,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, "description": "OK" } } @@ -62824,18 +99389,36 @@ "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, "description": "OK" } } @@ -62849,21 +99432,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -62877,21 +99471,34 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Order sort attribute ascending or descending.", "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -62899,7 +99506,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -62928,12 +99544,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -62944,16 +99570,31 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -62961,7 +99602,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -62983,7 +99630,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -62992,7 +99642,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63011,12 +99667,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63036,10 +99704,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63052,7 +99732,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63072,10 +99758,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63088,7 +99786,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63108,10 +99812,22 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, - "parent": { "description": "The parent term ID.", "type": "integer" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "type": "integer" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63124,7 +99840,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, "description": "OK" } } @@ -63138,21 +99860,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -63166,14 +99899,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -63187,7 +99928,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -63195,7 +99941,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -63217,12 +99972,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63233,15 +99998,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -63249,7 +100026,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63271,7 +100054,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -63280,7 +100066,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63299,12 +100091,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63324,9 +100128,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63339,7 +100152,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63359,9 +100178,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63374,7 +100202,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63394,9 +100228,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -63409,7 +100252,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, "description": "OK" } } @@ -63423,21 +100272,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed"] } + "schema": { + "enum": [ + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -63451,7 +100310,13 @@ "in": "query", "name": "type", "required": false, - "schema": { "enum": ["post", "term", "post-format"] } + "schema": { + "enum": [ + "post", + "post-format", + "term" + ] + } }, { "description": "Limit results to items of one or more object subtypes.", @@ -63460,7 +100325,16 @@ "required": false, "schema": { "items": { - "enum": ["post", "page", "product", "category", "post_tag", "product_cat", "product_tag", "any"], + "enum": [ + "any", + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], "type": "string" } } @@ -63470,19 +100344,33 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search-result" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/search-result" + } + } + }, "description": "OK" } } @@ -63492,7 +100380,13 @@ "get": { "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, "description": "OK" } } @@ -63503,8 +100397,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "date_format": { "description": "A date format for all date strings.", "type": "string" }, - "default_category": { "description": "Default post category.", "type": "integer" }, + "date_format": { + "description": "A date format for all date strings.", + "type": "string" + }, + "default_category": { + "description": "Default post category.", + "type": "integer" + }, "default_comment_status": { "description": "Allow people to submit comments on new posts.", "type": "string" @@ -63513,13 +100413,22 @@ "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", "type": "string" }, - "default_post_format": { "description": "Default post format.", "type": "string" }, - "description": { "description": "Site tagline.", "type": "string" }, + "default_post_format": { + "description": "Default post format.", + "type": "string" + }, + "description": { + "description": "Site tagline.", + "type": "string" + }, "email": { "description": "This address is used for admin purposes, like new user notification.", "type": "string" }, - "language": { "description": "WordPress locale code.", "type": "string" }, + "language": { + "description": "WordPress locale code.", + "type": "string" + }, "page_for_posts": { "description": "The ID of the page that should display the latest posts", "type": "integer" @@ -63532,19 +100441,46 @@ "description": "WooCommerce Local Pickup Method Settings", "type": "object" }, - "pickup_locations": { "description": "WooCommerce Local Pickup Locations", "type": "array" }, - "posts_per_page": { "description": "Blog pages show at most.", "type": "integer" }, - "show_on_front": { "description": "What to show on the front page", "type": "string" }, - "site_icon": { "description": "Site icon.", "type": "integer" }, - "site_logo": { "description": "Site logo.", "type": "integer" }, + "pickup_locations": { + "description": "WooCommerce Local Pickup Locations", + "type": "array" + }, + "posts_per_page": { + "description": "Blog pages show at most.", + "type": "integer" + }, + "show_on_front": { + "description": "What to show on the front page", + "type": "string" + }, + "site_icon": { + "description": "Site icon.", + "type": "integer" + }, + "site_logo": { + "description": "Site logo.", + "type": "integer" + }, "start_of_week": { "description": "A day number of the week that the week should start on.", "type": "integer" }, - "time_format": { "description": "A time format for all time strings.", "type": "string" }, - "timezone": { "description": "A city in the same timezone as you.", "type": "string" }, - "title": { "description": "Site title.", "type": "string" }, - "url": { "description": "Site URL.", "type": "string" }, + "time_format": { + "description": "A time format for all time strings.", + "type": "string" + }, + "timezone": { + "description": "A city in the same timezone as you.", + "type": "string" + }, + "title": { + "description": "Site title.", + "type": "string" + }, + "url": { + "description": "Site URL.", + "type": "string" + }, "use_smilies": { "description": "Convert emoticons like :-) and :-P to graphics on display.", "type": "boolean" @@ -63557,7 +100493,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, "description": "OK" } } @@ -63568,8 +100510,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "date_format": { "description": "A date format for all date strings.", "type": "string" }, - "default_category": { "description": "Default post category.", "type": "integer" }, + "date_format": { + "description": "A date format for all date strings.", + "type": "string" + }, + "default_category": { + "description": "Default post category.", + "type": "integer" + }, "default_comment_status": { "description": "Allow people to submit comments on new posts.", "type": "string" @@ -63578,13 +100526,22 @@ "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", "type": "string" }, - "default_post_format": { "description": "Default post format.", "type": "string" }, - "description": { "description": "Site tagline.", "type": "string" }, + "default_post_format": { + "description": "Default post format.", + "type": "string" + }, + "description": { + "description": "Site tagline.", + "type": "string" + }, "email": { "description": "This address is used for admin purposes, like new user notification.", "type": "string" }, - "language": { "description": "WordPress locale code.", "type": "string" }, + "language": { + "description": "WordPress locale code.", + "type": "string" + }, "page_for_posts": { "description": "The ID of the page that should display the latest posts", "type": "integer" @@ -63597,19 +100554,46 @@ "description": "WooCommerce Local Pickup Method Settings", "type": "object" }, - "pickup_locations": { "description": "WooCommerce Local Pickup Locations", "type": "array" }, - "posts_per_page": { "description": "Blog pages show at most.", "type": "integer" }, - "show_on_front": { "description": "What to show on the front page", "type": "string" }, - "site_icon": { "description": "Site icon.", "type": "integer" }, - "site_logo": { "description": "Site logo.", "type": "integer" }, + "pickup_locations": { + "description": "WooCommerce Local Pickup Locations", + "type": "array" + }, + "posts_per_page": { + "description": "Blog pages show at most.", + "type": "integer" + }, + "show_on_front": { + "description": "What to show on the front page", + "type": "string" + }, + "site_icon": { + "description": "Site icon.", + "type": "integer" + }, + "site_logo": { + "description": "Site logo.", + "type": "integer" + }, "start_of_week": { "description": "A day number of the week that the week should start on.", "type": "integer" }, - "time_format": { "description": "A time format for all time strings.", "type": "string" }, - "timezone": { "description": "A city in the same timezone as you.", "type": "string" }, - "title": { "description": "Site title.", "type": "string" }, - "url": { "description": "Site URL.", "type": "string" }, + "time_format": { + "description": "A time format for all time strings.", + "type": "string" + }, + "timezone": { + "description": "A city in the same timezone as you.", + "type": "string" + }, + "title": { + "description": "Site title.", + "type": "string" + }, + "url": { + "description": "Site URL.", + "type": "string" + }, "use_smilies": { "description": "Convert emoticons like :-) and :-P to graphics on display.", "type": "boolean" @@ -63622,7 +100606,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, "description": "OK" } } @@ -63633,8 +100623,14 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "date_format": { "description": "A date format for all date strings.", "type": "string" }, - "default_category": { "description": "Default post category.", "type": "integer" }, + "date_format": { + "description": "A date format for all date strings.", + "type": "string" + }, + "default_category": { + "description": "Default post category.", + "type": "integer" + }, "default_comment_status": { "description": "Allow people to submit comments on new posts.", "type": "string" @@ -63643,13 +100639,22 @@ "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", "type": "string" }, - "default_post_format": { "description": "Default post format.", "type": "string" }, - "description": { "description": "Site tagline.", "type": "string" }, + "default_post_format": { + "description": "Default post format.", + "type": "string" + }, + "description": { + "description": "Site tagline.", + "type": "string" + }, "email": { "description": "This address is used for admin purposes, like new user notification.", "type": "string" }, - "language": { "description": "WordPress locale code.", "type": "string" }, + "language": { + "description": "WordPress locale code.", + "type": "string" + }, "page_for_posts": { "description": "The ID of the page that should display the latest posts", "type": "integer" @@ -63662,19 +100667,46 @@ "description": "WooCommerce Local Pickup Method Settings", "type": "object" }, - "pickup_locations": { "description": "WooCommerce Local Pickup Locations", "type": "array" }, - "posts_per_page": { "description": "Blog pages show at most.", "type": "integer" }, - "show_on_front": { "description": "What to show on the front page", "type": "string" }, - "site_icon": { "description": "Site icon.", "type": "integer" }, - "site_logo": { "description": "Site logo.", "type": "integer" }, + "pickup_locations": { + "description": "WooCommerce Local Pickup Locations", + "type": "array" + }, + "posts_per_page": { + "description": "Blog pages show at most.", + "type": "integer" + }, + "show_on_front": { + "description": "What to show on the front page", + "type": "string" + }, + "site_icon": { + "description": "Site icon.", + "type": "integer" + }, + "site_logo": { + "description": "Site logo.", + "type": "integer" + }, "start_of_week": { "description": "A day number of the week that the week should start on.", "type": "integer" }, - "time_format": { "description": "A time format for all time strings.", "type": "string" }, - "timezone": { "description": "A city in the same timezone as you.", "type": "string" }, - "title": { "description": "Site title.", "type": "string" }, - "url": { "description": "Site URL.", "type": "string" }, + "time_format": { + "description": "A time format for all time strings.", + "type": "string" + }, + "timezone": { + "description": "A city in the same timezone as you.", + "type": "string" + }, + "title": { + "description": "Site title.", + "type": "string" + }, + "url": { + "description": "Site URL.", + "type": "string" + }, "use_smilies": { "description": "Convert emoticons like :-) and :-P to graphics on display.", "type": "boolean" @@ -63687,7 +100719,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, "description": "OK" } } @@ -63701,12 +100739,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } @@ -63727,23 +100777,48 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } }, "patch": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "widgets": { "description": "Nested widgets.", "type": "array" } }, + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, "type": "object" } } @@ -63751,18 +100826,37 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "widgets": { "description": "Nested widgets.", "type": "array" } }, + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, "type": "object" } } @@ -63770,18 +100864,37 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } }, "put": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "properties": { "widgets": { "description": "Nested widgets.", "type": "array" } }, + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, "type": "object" } } @@ -63789,7 +100902,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, "description": "OK" } } @@ -63803,12 +100922,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status" + } + } + }, "description": "OK" } } @@ -63829,12 +100960,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status" + } + } + }, "description": "OK" } } @@ -63848,21 +100991,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -63876,14 +101030,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -63897,7 +101059,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -63905,7 +101072,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -63927,12 +101103,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -63943,15 +101129,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -63959,7 +101157,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -63981,7 +101185,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -63990,7 +101197,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64009,12 +101222,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64034,9 +101259,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -64049,7 +101283,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64069,9 +101309,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -64084,7 +101333,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64104,9 +101359,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -64119,7 +101383,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, "description": "OK" } } @@ -64133,7 +101403,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Limit results to taxonomies associated with a specific post type.", @@ -64145,7 +101421,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxonomy" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taxonomy" + } + } + }, "description": "OK" } } @@ -64166,12 +101448,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxonomy" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taxonomy" + } + } + }, "description": "OK" } } @@ -64185,7 +101479,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Limit to the specified post ID.", @@ -64211,7 +101511,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64226,20 +101532,49 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, "slug": { "description": "Unique slug identifying the template.", "required": true, "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, - "required": ["slug"], + "required": [ + "slug" + ], "type": "object" } } @@ -64247,7 +101582,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64278,20 +101619,33 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/template-parts/{id}": { "delete": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -64300,32 +101654,62 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -64336,14 +101720,44 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64352,14 +101766,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -64370,14 +101796,44 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64386,14 +101842,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -64404,14 +101872,44 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64420,7 +101918,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64429,25 +101933,49 @@ "/wp/v2/template-parts/{id}/autosaves": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -64458,14 +101986,44 @@ "description": "Where the template part is intended for use (header, footer, etc)", "type": "string" }, - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64474,7 +102032,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64483,19 +102047,43 @@ "/wp/v2/template-parts/{parent}/autosaves/{id}": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64504,27 +102092,44 @@ "/wp/v2/template-parts/{parent}/revisions": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -64538,14 +102143,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -64559,19 +102172,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64580,7 +102214,13 @@ "/wp/v2/template-parts/{parent}/revisions/{id}": { "delete": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the revision.", "in": "path", @@ -64606,14 +102246,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the revision.", "in": "path", @@ -64626,12 +102278,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, "description": "OK" } } @@ -64645,7 +102309,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Limit to the specified post ID.", @@ -64671,7 +102341,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64682,20 +102358,49 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, "slug": { "description": "Unique slug identifying the template.", "required": true, "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, - "required": ["slug"], + "required": [ + "slug" + ], "type": "object" } } @@ -64703,7 +102408,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64734,20 +102445,33 @@ "schema": {} } ], - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/templates/{id}": { "delete": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Whether to bypass Bin and force deletion.", "type": "boolean" } + "force": { + "description": "Whether to bypass Bin and force deletion.", + "type": "boolean" + } }, "type": "object" } @@ -64756,46 +102480,106 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64804,28 +102588,70 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64834,28 +102660,70 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64864,7 +102732,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64873,39 +102747,93 @@ "/wp/v2/templates/{id}/autosaves": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The ID of a template", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "author": { "description": "The ID for the author of the template.", "type": "integer" }, - "content": { "description": "Content of template.", "type": ["object", "string"] }, - "description": { "description": "Description of template.", "type": "string" }, - "slug": { "description": "Unique slug identifying the template.", "type": "string" }, - "status": { "description": "Status of template.", "type": "string" }, - "theme": { "description": "Theme identifier for the template.", "type": "string" }, - "title": { "description": "Title of template.", "type": ["object", "string"] }, - "type": { "description": "Type of template.", "type": "string" } + "author": { + "description": "The ID for the author of the template.", + "type": "integer" + }, + "content": { + "description": "Content of template.", + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "type": "string" + }, + "status": { + "description": "Status of template.", + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "description": "Title of template.", + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "type": "string" + } }, "type": "object" } @@ -64914,7 +102842,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64923,19 +102857,43 @@ "/wp/v2/templates/{parent}/autosaves/{id}": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, - { "description": "The ID for the autosave.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "The ID for the autosave.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -64944,27 +102902,44 @@ "/wp/v2/templates/{parent}/revisions": { "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -64978,14 +102953,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -64999,19 +102982,40 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by object attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } + "schema": { + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -65020,7 +103024,13 @@ "/wp/v2/templates/{parent}/revisions/{id}": { "delete": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the revision.", "in": "path", @@ -65046,14 +103056,26 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } }, "get": { "parameters": [ - { "description": "The ID of a template", "in": "path", "name": "parent", "required": true, "schema": {} }, + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, { "description": "Unique identifier for the revision.", "in": "path", @@ -65066,12 +103088,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, "description": "OK" } } @@ -65085,12 +103119,26 @@ "in": "query", "name": "status", "required": false, - "schema": { "items": { "enum": ["active", "inactive"], "type": "string" } } + "schema": { + "items": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/theme" + } + } + }, "description": "OK" } } @@ -65109,7 +103157,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/theme" + } + } + }, "description": "OK" } } @@ -65123,12 +103177,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/type" + } + } + }, "description": "OK" } } @@ -65149,12 +103215,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/type" + } + } + }, "description": "OK" } } @@ -65168,21 +103246,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -65196,14 +103285,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -65217,42 +103314,74 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by user attribute.", "in": "query", "name": "orderby", "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url"] } + "schema": { + "enum": [ + "email", + "id", + "include", + "include_slugs", + "name", + "registered_date", + "slug", + "url" + ] + } }, { "description": "Limit result set to users with one or more specific slugs.", "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "in": "query", "name": "roles", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", "in": "query", "name": "capabilities", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { "description": "Limit result set to users who are considered authors.", "in": "query", "name": "who", "required": false, - "schema": { "enum": ["authors"] } + "schema": { + "enum": [ + "authors" + ] + } }, { "description": "Limit result set to users who have published posts.", @@ -65282,7 +103411,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65293,25 +103428,67 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "required": true, "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, "password": { "description": "Password for the user (never included).", "required": true, "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "required": true, "type": "string" } + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "required": true, + "type": "string" + } }, - "required": ["username", "email", "password"], + "required": [ + "email", + "password", + "username" + ], "type": "object" } } @@ -65319,7 +103496,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65342,7 +103525,9 @@ "type": "integer" } }, - "required": ["reassign"], + "required": [ + "reassign" + ], "type": "object" } } @@ -65350,7 +103535,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65362,12 +103553,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65378,19 +103581,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65399,7 +103641,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65410,19 +103658,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65431,7 +103718,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65442,19 +103735,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65463,7 +103795,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65495,7 +103833,9 @@ "type": "integer" } }, - "required": ["reassign"], + "required": [ + "reassign" + ], "type": "object" } } @@ -65503,7 +103843,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65522,12 +103868,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65547,19 +103905,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65568,7 +103965,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65588,19 +103991,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65609,7 +104051,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65629,19 +104077,58 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "Description of the user.", "type": "string" }, - "email": { "description": "The email address for the user.", "type": "string" }, - "first_name": { "description": "First name for the user.", "type": "string" }, - "last_name": { "description": "Last name for the user.", "type": "string" }, - "locale": { "description": "Locale for the user.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "Display name for the user.", "type": "string" }, - "nickname": { "description": "The nickname for the user.", "type": "string" }, - "password": { "description": "Password for the user (never included).", "type": "string" }, - "roles": { "description": "Roles assigned to the user.", "type": "array" }, - "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, - "url": { "description": "URL of the user.", "type": "string" }, - "username": { "description": "Login name for the user.", "type": "string" } + "description": { + "description": "Description of the user.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "description": "URL of the user.", + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "type": "string" + } }, "type": "object" } @@ -65650,7 +104137,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, "description": "OK" } } @@ -65658,10 +104151,24 @@ }, "/wp/v2/users/{user_id}/application-passwords": { "delete": { - "parameters": [{ "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65673,19 +104180,45 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } }, "post": { - "parameters": [{ "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -65695,9 +104228,15 @@ "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "type": "string" }, - "name": { "description": "The name of the application password.", "required": true, "type": "string" } + "name": { + "description": "The name of the application password.", + "required": true, + "type": "string" + } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -65705,7 +104244,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65719,13 +104264,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65734,12 +104297,30 @@ "/wp/v2/users/{user_id}/application-passwords/{uuid}": { "delete": { "parameters": [ - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65751,22 +104332,58 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } }, "patch": { "parameters": [ - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -65777,7 +104394,10 @@ "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "type": "string" }, - "name": { "description": "The name of the application password.", "type": "string" } + "name": { + "description": "The name of the application password.", + "type": "string" + } }, "type": "object" } @@ -65786,15 +104406,33 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } }, "post": { "parameters": [ - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -65805,7 +104443,10 @@ "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "type": "string" }, - "name": { "description": "The name of the application password.", "type": "string" } + "name": { + "description": "The name of the application password.", + "type": "string" + } }, "type": "object" } @@ -65814,15 +104455,33 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } }, "put": { "parameters": [ - { "description": "", "in": "path", "name": "user_id", "required": true, "schema": {} }, - { "description": "", "in": "path", "name": "uuid", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -65833,7 +104492,10 @@ "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "type": "string" }, - "name": { "description": "The name of the application password.", "type": "string" } + "name": { + "description": "The name of the application password.", + "type": "string" + } }, "type": "object" } @@ -65842,7 +104504,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, "description": "OK" } } @@ -65856,12 +104524,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget-type" + } + } + }, "description": "OK" } } @@ -65870,18 +104550,36 @@ "/wp/v2/widget-types/{id}": { "get": { "parameters": [ - { "description": "The widget type ID.", "in": "path", "name": "id", "required": true, "schema": {} }, + { + "description": "The widget type ID.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, { "description": "Scope under which the request is made; determines fields present in response.", "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget-type" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget-type" + } + } + }, "description": "OK" } } @@ -65890,7 +104588,13 @@ "/wp/v2/widget-types/{id}/encode": { "post": { "parameters": [ - { "description": "The widget type ID.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The widget type ID.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { @@ -65901,34 +104605,54 @@ "description": "Serialised widget form data to encode into instance settings.", "type": "string" }, - "instance": { "description": "Current instance settings of the widget.", "type": "object" } + "instance": { + "description": "Current instance settings of the widget.", + "type": "object" + } }, "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/widget-types/{id}/render": { "post": { "parameters": [ - { "description": "The widget type ID.", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "The widget type ID.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { - "instance": { "description": "Current instance settings of the widget.", "type": "object" } + "instance": { + "description": "Current instance settings of the widget.", + "type": "object" + } }, "type": "object" } } } }, - "responses": { "200": { "description": "OK" } } + "responses": { + "200": { + "description": "OK" + } + } } }, "/wp/v2/widgets": { @@ -65939,7 +104663,13 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "The sidebar for which to return widgets.", @@ -65951,7 +104681,13 @@ ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -65966,19 +104702,27 @@ "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", "type": "string" }, - "id": { "description": "Unique identifier for the widget.", "type": "string" }, + "id": { + "description": "Unique identifier for the widget.", + "type": "string" + }, "id_base": { "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, - "instance": { "description": "Instance settings of the widget, if supported.", "type": "object" }, + "instance": { + "description": "Instance settings of the widget, if supported.", + "type": "object" + }, "sidebar": { "description": "The sidebar to which the widget belongs.", "required": true, "type": "string" } }, - "required": ["sidebar"], + "required": [ + "sidebar" + ], "type": "object" } } @@ -65986,7 +104730,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -65994,7 +104744,15 @@ }, "/wp/v2/widgets/{id}": { "delete": { - "parameters": [{ "description": "", "in": "path", "name": "id", "required": true, "schema": {} }], + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -66012,7 +104770,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66024,13 +104788,31 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, - { "description": "", "in": "path", "name": "id", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66058,8 +104840,14 @@ "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, - "instance": { "description": "Instance settings of the widget, if supported.", "type": "object" }, - "sidebar": { "description": "The sidebar to which the widget belongs.", "type": "string" } + "instance": { + "description": "Instance settings of the widget, if supported.", + "type": "object" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } }, "type": "object" } @@ -66068,7 +104856,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66096,8 +104890,14 @@ "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, - "instance": { "description": "Instance settings of the widget, if supported.", "type": "object" }, - "sidebar": { "description": "The sidebar to which the widget belongs.", "type": "string" } + "instance": { + "description": "Instance settings of the widget, if supported.", + "type": "object" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } }, "type": "object" } @@ -66106,7 +104906,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66134,8 +104940,14 @@ "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "type": "string" }, - "instance": { "description": "Instance settings of the widget, if supported.", "type": "object" }, - "sidebar": { "description": "The sidebar to which the widget belongs.", "type": "string" } + "instance": { + "description": "Instance settings of the widget, if supported.", + "type": "object" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } }, "type": "object" } @@ -66144,7 +104956,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, "description": "OK" } } @@ -66158,21 +104976,32 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } }, { "description": "Current page of the collection.", "in": "query", "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { "description": "Maximum number of items to be returned in result set.", "in": "query", "name": "per_page", "required": false, - "schema": { "maximum": 100, "minimum": 1 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { "description": "Limit results to those matching a string.", @@ -66186,14 +105015,22 @@ "in": "query", "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Limit result set to specific IDs.", "in": "query", "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { "description": "Offset the result set by a specific number of items.", @@ -66207,7 +105044,12 @@ "in": "query", "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { "description": "Sort collection by term attribute.", @@ -66215,7 +105057,16 @@ "name": "orderby", "required": false, "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] } }, { @@ -66237,12 +105088,22 @@ "in": "query", "name": "slug", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66253,15 +105114,27 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } } @@ -66269,7 +105142,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66291,7 +105170,10 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "force": { "description": "Required to be true, as terms do not support binning.", "type": "boolean" } + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } }, "type": "object" } @@ -66300,7 +105182,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66319,12 +105207,24 @@ "in": "query", "name": "context", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } } ], "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66344,9 +105244,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -66359,7 +105268,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66379,9 +105294,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -66394,7 +105318,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66414,9 +105344,18 @@ "application/x-www-form-urlencoded": { "schema": { "properties": { - "description": { "description": "HTML description of the term.", "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object" }, - "name": { "description": "HTML title for the term.", "type": "string" }, + "description": { + "description": "HTML description of the term.", + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "type": "string" + }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" @@ -66429,7 +105368,13 @@ }, "responses": { "200": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, "description": "OK" } } @@ -66437,23 +105382,75 @@ } }, "security": [], - "servers": [{ "url": "https:/haikuatelier.fr.ddev.site/wp-json" }], + "servers": [ + { + "url": "https:/haikuatelier.fr.ddev.site/wp-json" + } + ], "tags": [ - { "description": "", "name": "wc/v3" }, - { "description": "", "name": "wp-openapi/v1" }, - { "description": "", "name": "jetpack/v4" }, - { "description": "", "name": "wc-admin" }, - { "description": "", "name": "wc-analytics" }, - { "description": "", "name": "wc/store" }, - { "description": "", "name": "wc/store/v1" }, - { "description": "", "name": "wc/private" }, - { "description": "", "name": "wc/v1" }, - { "description": "", "name": "wc/v2" }, - { "description": "", "name": "wc-telemetry" }, - { "description": "", "name": "wccom-site/v3" }, - { "description": "", "name": "carbon-fields/v1" }, - { "description": "", "name": "wp/v2" }, - { "description": "", "name": "wp-site-health/v1" }, - { "description": "", "name": "wp-block-editor/v1" } + { + "description": "", + "name": "wc/v3" + }, + { + "description": "", + "name": "wp-openapi/v1" + }, + { + "description": "", + "name": "jetpack/v4" + }, + { + "description": "", + "name": "wc-admin" + }, + { + "description": "", + "name": "wc-analytics" + }, + { + "description": "", + "name": "wc/store" + }, + { + "description": "", + "name": "wc/store/v1" + }, + { + "description": "", + "name": "wc/private" + }, + { + "description": "", + "name": "wc/v1" + }, + { + "description": "", + "name": "wc/v2" + }, + { + "description": "", + "name": "wc-telemetry" + }, + { + "description": "", + "name": "wccom-site/v3" + }, + { + "description": "", + "name": "carbon-fields/v1" + }, + { + "description": "", + "name": "wp/v2" + }, + { + "description": "", + "name": "wp-site-health/v1" + }, + { + "description": "", + "name": "wp-block-editor/v1" + } ] } diff --git a/lib/wp-json-schema.json b/lib/wp-json-schema.json index 0e03e20b..ad87d7d6 100755 --- a/lib/wp-json-schema.json +++ b/lib/wp-json-schema.json @@ -12,21 +12,21 @@ "home": "https://haikuatelier.fr.ddev.site", "name": "Haiku Atelier", "namespaces": [ - "wc/v3", + "carbon-fields/v1", "jetpack/v4", "wc-admin", "wc-analytics", + "wc-telemetry", + "wc/private", "wc/store", "wc/store/v1", - "wc/private", "wc/v1", "wc/v2", - "wc-telemetry", + "wc/v3", "wccom-site/v3", - "carbon-fields/v1", - "wp/v2", + "wp-block-editor/v1", "wp-site-health/v1", - "wp-block-editor/v1" + "wp/v2" ], "routes": { "/": { @@ -45,10 +45,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "" }, "/batch/v1": { @@ -75,14 +79,22 @@ "items": { "type": "string" }, - "type": ["string", "array"] + "type": [ + "array", + "string" + ] }, "properties": [], "type": "object" }, "method": { "default": "POST", - "enum": ["POST", "PUT", "PATCH", "DELETE"], + "enum": [ + "DELETE", + "PATCH", + "POST", + "PUT" + ], "type": "string" }, "path": { @@ -98,15 +110,22 @@ }, "validation": { "default": "normal", - "enum": ["require-all-validate", "normal"], + "enum": [ + "normal", + "require-all-validate" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "" }, "/carbon-fields/v1": { @@ -129,10 +148,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/association": { @@ -146,10 +169,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/association/options": { @@ -163,10 +190,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/attachment": { @@ -191,10 +222,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/block-renderer": { @@ -224,20 +259,28 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "carbon-fields/v1" }, - "/carbon-fields/v1/comments/(?P\u003Cid\u003E\\d+)": { + "/carbon-fields/v1/comments/(?P\\d+)": { "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/options": { @@ -251,40 +294,58 @@ "endpoints": [ { "args": [], - "methods": ["GET", "POST"] + "methods": [ + "GET", + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "carbon-fields/v1" }, - "/carbon-fields/v1/posts/(?P\u003Cid\u003E\\d+)": { + "/carbon-fields/v1/posts/(?P\\d+)": { "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "carbon-fields/v1" }, - "/carbon-fields/v1/terms/(?P\u003Cid\u003E\\d+)": { + "/carbon-fields/v1/terms/(?P\\d+)": { "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "carbon-fields/v1" }, - "/carbon-fields/v1/users/(?P\u003Cid\u003E\\d+)": { + "/carbon-fields/v1/users/(?P\\d+)": { "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "carbon-fields/v1" }, "/jetpack/v4": { @@ -307,10 +368,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection": { @@ -324,7 +389,9 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -333,10 +400,19 @@ "required": true } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/authorize_url": { @@ -356,10 +432,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/data": { @@ -373,10 +453,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/owner": { @@ -396,10 +480,18 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/plugins": { @@ -413,10 +505,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/reconnect": { @@ -430,10 +526,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/register": { @@ -468,10 +572,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/remote_authorize": { @@ -485,10 +597,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/user-token": { @@ -513,10 +633,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/verify_registration": { @@ -530,10 +658,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "jetpack/v4" }, "/jetpack/v4/verify_xmlrpc_error": { @@ -552,10 +688,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "jetpack/v4" }, "/wc-admin": { @@ -578,10 +718,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/experiments/assignment": { @@ -595,10 +739,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/features": { @@ -612,10 +760,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/initialize-coming-soon": { @@ -629,10 +781,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/survey-completed": { @@ -646,10 +802,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/update-survey-status": { @@ -664,15 +824,22 @@ { "args": { "status": { - "enum": ["yes", "no"], + "enum": [ + "no", + "yes" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/woopayments/test-orders": { @@ -686,10 +853,14 @@ "endpoints": [ { "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["DELETE"], + "methods": [ + "DELETE" + ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/woopayments/test-orders/count": { @@ -703,10 +874,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/marketing/campaign-types": { @@ -722,7 +897,9 @@ "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -742,10 +919,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/marketing/campaigns": { @@ -761,7 +942,9 @@ "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -781,10 +964,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/marketing/channels": { @@ -798,10 +985,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/marketing/knowledge-base": { @@ -820,10 +1011,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/marketing/overview/activate-plugin": { @@ -842,10 +1037,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/marketing/overview/installed-plugins": { @@ -859,10 +1062,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/marketing/recommendations": { @@ -877,15 +1084,22 @@ { "args": { "category": { - "enum": ["channels", "extensions"], + "enum": [ + "channels", + "extensions" + ], "required": true, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/marketing/recommended": { @@ -912,10 +1126,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/mobile-app": { @@ -929,10 +1147,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/mobile-app/send-magic-link": { @@ -946,10 +1168,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/navigation/favorites/me": { @@ -963,7 +1189,9 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -971,7 +1199,9 @@ "required": true } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { @@ -979,10 +1209,16 @@ "required": true } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "DELETE"], + "methods": [ + "DELETE", + "GET", + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/notice/dismiss": { @@ -996,10 +1232,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/free-extensions": { @@ -1013,10 +1253,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/plugins/install-and-activate": { @@ -1030,10 +1274,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/plugins/install-and-activate-async": { @@ -1054,10 +1302,14 @@ "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/plugins/jetpack-authorization-url": { @@ -1083,20 +1335,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, - "/wc-admin/onboarding/plugins/scheduled-installs/(?P\u003Cjob_id\u003E\\w+)": { + "/wc-admin/onboarding/plugins/scheduled-installs/(?P\\w+)": { "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/product-types": { @@ -1110,10 +1370,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/products": { @@ -1127,10 +1391,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/profile": { @@ -1144,7 +1412,9 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -1164,7 +1434,9 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -1193,13 +1465,30 @@ }, "number_employees": { "description": "Number of employees of the store.", - "enum": ["1", "\u003C10", "10-50", "50-250", "+250", "not specified"], + "enum": [ + "+250", + "<10", + "1", + "10-50", + "50-250", + "not specified" + ], "required": false, "type": "string" }, "other_platform": { "description": "Name of other platform used to sell.", - "enum": ["shopify", "bigcommerce", "magento", "wix", "amazon", "ebay", "etsy", "squarespace", "other"], + "enum": [ + "amazon", + "bigcommerce", + "ebay", + "etsy", + "magento", + "other", + "shopify", + "squarespace", + "wix" + ], "required": false, "type": "string" }, @@ -1210,7 +1499,13 @@ }, "product_count": { "description": "Number of products to be added.", - "enum": ["0", "1-10", "11-100", "101-1000", "1000+"], + "enum": [ + "0", + "1-10", + "1000+", + "101-1000", + "11-100" + ], "required": false, "type": "string" }, @@ -1218,13 +1513,13 @@ "description": "Types of products sold.", "items": { "enum": [ - "physical", - "downloads", - "subscriptions", - "memberships", "bookings", + "downloads", + "memberships", + "physical", + "product-add-ons", "product-bundles", - "product-add-ons" + "subscriptions" ], "type": "string" }, @@ -1234,20 +1529,26 @@ "revenue": { "description": "Current annual revenue of the store.", "enum": [ - "none", - "up-to-2500", - "2500-10000", "10000-50000", + "2500-10000", "50000-250000", "more-than-250000", - "rather-not-say" + "none", + "rather-not-say", + "up-to-2500" ], "required": false, "type": "string" }, "selling_venues": { "description": "Other places the store is selling products.", - "enum": ["no", "other", "brick-mortar", "brick-mortar-other", "other-woocommerce"], + "enum": [ + "brick-mortar", + "brick-mortar-other", + "no", + "other", + "other-woocommerce" + ], "required": false, "type": "string" }, @@ -1277,10 +1578,19 @@ "type": "boolean" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/profile/experimental_get_email_prefill": { @@ -1294,10 +1604,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks": { @@ -1314,14 +1628,20 @@ "ids": { "description": "Optional parameter to get only specific task lists by ID.", "items": { - "enum": ["setup", "extended", "secret_tasklist"], + "enum": [ + "extended", + "secret_tasklist", + "setup" + ], "type": "string" }, "required": false, "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -1333,20 +1653,29 @@ "ids": { "description": "Optional parameter to get only specific task lists by ID.", "items": { - "enum": ["setup", "extended", "secret_tasklist"], + "enum": [ + "extended", + "secret_tasklist", + "setup" + ], "type": "string" }, "required": false, "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc-admin" }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_-]+)/snooze": { + "/wc-admin/onboarding/tasks/(?P[a-z0-9_-]+)/snooze": { "endpoints": [ { "args": { @@ -1361,70 +1690,122 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/action": { + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/action": { "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/dismiss": { + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/dismiss": { "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/hide": { + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/hide": { "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/undo_dismiss": { + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/undo_dismiss": { "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/undo_snooze": { + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/undo_snooze": { "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/unhide": { + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/unhide": { "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/create_homepage": { @@ -1438,10 +1819,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/create_product_from_template": { @@ -1461,10 +1846,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/import_sample_products": { @@ -1478,10 +1867,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/themes/activate": { @@ -1495,10 +1888,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/themes/install": { @@ -1512,10 +1913,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/onboarding/themes/recommended": { @@ -1532,7 +1941,13 @@ "currency": { "default": "USD", "description": "Returns pricing in this currency (optional, default: USD)", - "enum": ["USD", "AUD", "CAD", "EUR", "GBP"], + "enum": [ + "AUD", + "CAD", + "EUR", + "GBP", + "USD" + ], "required": false, "type": "string" }, @@ -1542,10 +1957,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/options": { @@ -1559,14 +1978,25 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/payment-gateway-suggestions": { @@ -1586,10 +2016,14 @@ "type": "boolean" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/payment-gateway-suggestions/dismiss": { @@ -1603,10 +2037,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/activate": { @@ -1620,10 +2058,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/activate/status": { @@ -1637,20 +2083,28 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, - "/wc-admin/plugins/activate/status/(?P\u003Cjob_id\u003E[a-z0-9_\\-]+)": { + "/wc-admin/plugins/activate/status/(?P[a-z0-9_\\-]+)": { "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/active": { @@ -1664,10 +2118,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/connect-jetpack": { @@ -1681,10 +2139,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/connect-square": { @@ -1698,10 +2160,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/connect-wcpay": { @@ -1715,10 +2185,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/finish-wccom-connect": { @@ -1732,10 +2210,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/install": { @@ -1749,10 +2231,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/install/status": { @@ -1766,20 +2256,28 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, - "/wc-admin/plugins/install/status/(?P\u003Cjob_id\u003E[a-z0-9_\\-]+)": { + "/wc-admin/plugins/install/status/(?P[a-z0-9_\\-]+)": { "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/installed": { @@ -1793,10 +2291,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/plugins/request-wccom-connect": { @@ -1810,10 +2312,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-admin" }, "/wc-admin/shipping-partner-suggestions": { @@ -1833,10 +2339,14 @@ "type": "boolean" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-admin" }, "/wc-admin/themes": { @@ -1853,7 +2363,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -1863,10 +2376,18 @@ "type": "file" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-admin" }, "/wc-analytics": { @@ -1889,10 +2410,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes": { @@ -1909,21 +2434,33 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["note_id", "date", "type", "title", "status"], + "enum": [ + "date", + "note_id", + "status", + "title", + "type" + ], "required": false, "type": "string" }, @@ -1953,7 +2490,13 @@ "status": { "description": "Status of note.", "items": { - "enum": ["pending", "actioned", "unactioned", "snoozed", "sent"], + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], "type": "string" }, "required": false, @@ -1962,35 +2505,57 @@ "type": { "description": "Type of note.", "items": { - "enum": ["error", "warning", "update", "info", "marketing", "survey", "email"], + "enum": [ + "email", + "error", + "info", + "marketing", + "survey", + "update", + "warning" + ], "type": "string" }, "required": false, "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["note_id", "date", "type", "title", "status"], + "enum": [ + "date", + "note_id", + "status", + "title", + "type" + ], "required": false, "type": "string" }, @@ -2020,7 +2585,13 @@ "status": { "description": "Status of note.", "items": { - "enum": ["pending", "actioned", "unactioned", "snoozed", "sent"], + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], "type": "string" }, "required": false, @@ -2029,20 +2600,33 @@ "type": { "description": "Type of note.", "items": { - "enum": ["error", "warning", "update", "info", "marketing", "survey", "email"], + "enum": [ + "email", + "error", + "info", + "marketing", + "survey", + "update", + "warning" + ], "type": "string" }, "required": false, "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, - "/wc-analytics/admin/notes/(?P\u003Cid\u003E[\\d-]+)": { + "/wc-analytics/admin/notes/(?P[\\d-]+)": { "endpoints": [ { "args": { @@ -2052,7 +2636,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -2062,7 +2648,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -2072,7 +2662,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -2082,13 +2674,26 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, - "/wc-analytics/admin/notes/(?P\u003Cnote_id\u003E[\\d-]+)/action/(?P\u003Caction_id\u003E[\\d-]+)": { + "/wc-analytics/admin/notes/(?P[\\d-]+)/action/(?P[\\d-]+)": { "endpoints": [ { "args": { @@ -2103,7 +2708,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -2118,24 +2727,42 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, - "/wc-analytics/admin/notes/delete/(?P\u003Cid\u003E[\\d-]+)": { + "/wc-analytics/admin/notes/delete/(?P[\\d-]+)": { "endpoints": [ { "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] }, { "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["DELETE", "DELETE"], + "methods": [ + "DELETE", + "DELETE" + ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes/delete/all": { @@ -2152,59 +2779,100 @@ "status": { "description": "Status of note.", "items": { - "enum": ["pending", "actioned", "unactioned", "snoozed", "sent"], + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], "type": "string" }, "required": false, "type": "array" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] }, { "args": { "status": { "description": "Status of note.", "items": { - "enum": ["pending", "actioned", "unactioned", "snoozed", "sent"], + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], "type": "string" }, "required": false, "type": "array" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["DELETE", "DELETE"], + "methods": [ + "DELETE", + "DELETE" + ], "namespace": "wc-analytics" }, - "/wc-analytics/admin/notes/experimental-activate-promo/(?P\u003Cpromo_note_name\u003E[\\w-]+)": { + "/wc-analytics/admin/notes/experimental-activate-promo/(?P[\\w-]+)": { "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, - "/wc-analytics/admin/notes/tracker/(?P\u003Cnote_id\u003E[\\d-]+)/user/(?P\u003Cuser_id\u003E[\\d-]+)": { + "/wc-analytics/admin/notes/tracker/(?P[\\d-]+)/user/(?P[\\d-]+)": { "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes/update": { @@ -2218,14 +2886,29 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/coupons": { @@ -2259,7 +2942,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -2307,14 +2993,24 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -2339,7 +3035,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -2356,12 +3054,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -2371,7 +3075,11 @@ "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -2432,20 +3140,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -2490,7 +3215,9 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { @@ -2514,7 +3241,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -2562,14 +3292,24 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -2594,7 +3334,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -2611,12 +3353,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -2626,7 +3374,11 @@ "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -2687,20 +3439,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -2745,20 +3514,30 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST", "GET", "POST"], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], "namespace": "wc-analytics" }, - "/wc-analytics/coupons/(?P\u003Cid\u003E[\\d]+)": { + "/wc-analytics/coupons/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -2768,7 +3547,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -2785,12 +3566,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -2799,7 +3586,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -2862,20 +3653,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -2920,7 +3728,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -2936,14 +3748,19 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -2953,7 +3770,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -2970,12 +3789,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -2984,7 +3809,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -3047,20 +3876,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -3105,7 +3951,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -3121,10 +3971,23 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "DELETE", + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/coupons/batch": { @@ -3151,12 +4014,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -3165,7 +4034,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -3223,20 +4096,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -3281,7 +4171,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -3298,12 +4192,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -3312,7 +4212,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -3370,20 +4274,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -3428,10 +4349,21 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/customers": { @@ -3478,7 +4410,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -3505,7 +4440,14 @@ "filter_empty": { "description": "Filter out results where any of the passed fields are empty", "items": { - "enum": ["email", "name", "country", "city", "state", "postcode"], + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], "type": "string" }, "required": false, @@ -3559,7 +4501,10 @@ "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, @@ -3576,7 +4521,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -3584,17 +4532,17 @@ "default": "date_registered", "description": "Sort collection by object attribute.", "enum": [ - "username", - "name", - "country", + "avg_order_value", "city", - "state", - "postcode", - "date_registered", + "country", "date_last_active", + "date_registered", + "name", "orders_count", + "postcode", + "state", "total_spend", - "avg_order_value" + "username" ], "required": false, "type": "string" @@ -3660,7 +4608,12 @@ "searchby": { "default": "name", "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "enum": ["name", "username", "email", "all"], + "enum": [ + "all", + "email", + "name", + "username" + ], "required": false, "type": "string" }, @@ -3701,13 +4654,17 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, - "/wc-analytics/customers/(?P\u003Cid\u003E[\\d-]+)": { + "/wc-analytics/customers/(?P[\\d-]+)": { "endpoints": [ { "args": { @@ -3744,7 +4701,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -3771,7 +4731,14 @@ "filter_empty": { "description": "Filter out results where any of the passed fields are empty", "items": { - "enum": ["email", "name", "country", "city", "state", "postcode"], + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], "type": "string" }, "required": false, @@ -3830,7 +4797,10 @@ "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, @@ -3847,7 +4817,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -3855,17 +4828,17 @@ "default": "date_registered", "description": "Sort collection by object attribute.", "enum": [ - "username", - "name", - "country", + "avg_order_value", "city", - "state", - "postcode", - "date_registered", + "country", "date_last_active", + "date_registered", + "name", "orders_count", + "postcode", + "state", "total_spend", - "avg_order_value" + "username" ], "required": false, "type": "string" @@ -3931,7 +4904,12 @@ "searchby": { "default": "name", "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "enum": ["name", "username", "email", "all"], + "enum": [ + "all", + "email", + "name", + "username" + ], "required": false, "type": "string" }, @@ -3972,10 +4950,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/data": { @@ -3989,14 +4971,21 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/data/countries": { @@ -4010,17 +4999,24 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, - "/wc-analytics/data/countries/(?P\u003Clocation\u003E[\\w-]+)": { + "/wc-analytics/data/countries/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -4030,7 +5026,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -4040,10 +5038,15 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/data/countries/locales": { @@ -4057,14 +5060,21 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/data/download-ips": { @@ -4078,14 +5088,21 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/leaderboards": { @@ -4132,13 +5149,17 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, - "/wc-analytics/leaderboards/(?P\u003Cleaderboard\u003E\\w+)": { + "/wc-analytics/leaderboards/(?P\\w+)": { "endpoints": [ { "args": { @@ -4155,7 +5176,12 @@ "type": "string" }, "leaderboard": { - "enum": ["customers", "coupons", "categories", "products"], + "enum": [ + "categories", + "coupons", + "customers", + "products" + ], "required": false, "type": "string" }, @@ -4180,10 +5206,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/leaderboards/allowed": { @@ -4197,10 +5227,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/orders": { @@ -4229,7 +5263,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -4311,7 +5348,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -4324,7 +5364,14 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -4372,20 +5419,22 @@ "type": "string" }, "status": { - "default": ["any"], + "default": [ + "any" + ], "description": "Limit result set to orders which have specific statuses.", "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" }, @@ -4393,7 +5442,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -4401,58 +5452,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -4465,60 +5552,104 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -4526,7 +5657,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -4565,8 +5698,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -4724,31 +5857,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -4756,40 +5912,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -4801,12 +5989,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -4822,22 +6016,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -4847,35 +6053,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -4883,70 +6115,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -4957,18 +6244,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -4989,20 +6285,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -5035,47 +6348,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -5088,36 +6428,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -5125,28 +6491,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -5158,12 +6555,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -5179,14 +6582,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -5197,7 +6600,9 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { @@ -5216,7 +6621,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -5298,7 +6706,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -5311,7 +6722,14 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -5359,20 +6777,22 @@ "type": "string" }, "status": { - "default": ["any"], + "default": [ + "any" + ], "description": "Limit result set to orders which have specific statuses.", "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" }, @@ -5380,7 +6800,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -5388,58 +6810,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -5452,60 +6910,104 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -5513,7 +7015,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -5552,8 +7056,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -5711,31 +7215,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -5743,40 +7270,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -5788,12 +7347,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -5809,22 +7374,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -5834,35 +7411,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -5870,70 +7473,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -5944,18 +7602,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -5976,20 +7643,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -6022,47 +7706,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -6075,36 +7786,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -6112,28 +7849,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -6145,12 +7913,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -6166,14 +7940,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -6184,20 +7958,30 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST", "GET", "POST"], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], "namespace": "wc-analytics" }, - "/wc-analytics/orders/(?P\u003Cid\u003E[\\d]+)": { + "/wc-analytics/orders/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -6207,7 +7991,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -6215,58 +8001,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -6279,60 +8101,104 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -6340,7 +8206,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -6378,8 +8246,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -6536,31 +8404,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -6568,40 +8459,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -6613,12 +8536,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -6639,22 +8568,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -6664,35 +8605,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -6700,70 +8667,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -6774,18 +8796,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -6805,20 +8836,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -6850,47 +8898,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -6903,36 +8978,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -6940,28 +9041,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -6973,12 +9105,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -6993,14 +9131,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -7011,7 +9149,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -7027,14 +9169,19 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -7044,7 +9191,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -7052,58 +9201,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -7116,60 +9301,104 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -7177,7 +9406,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -7215,8 +9446,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -7373,31 +9604,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -7405,40 +9659,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -7450,12 +9736,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -7476,22 +9768,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -7501,35 +9805,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -7537,70 +9867,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -7611,18 +9996,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -7642,20 +10036,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -7687,47 +10098,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -7740,36 +10178,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -7777,28 +10241,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -7810,12 +10305,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -7830,14 +10331,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -7848,7 +10349,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -7864,10 +10369,23 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "DELETE", + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/orders/batch": { @@ -7885,58 +10403,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -7949,60 +10503,104 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -8010,7 +10608,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -8048,8 +10648,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -8206,31 +10806,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -8238,40 +10861,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -8283,12 +10938,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -8304,22 +10965,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -8329,35 +11002,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -8365,70 +11064,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -8439,18 +11193,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -8470,20 +11233,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -8515,47 +11295,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -8568,36 +11375,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -8605,28 +11438,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -8638,12 +11502,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -8658,14 +11528,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -8676,7 +11546,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -8684,58 +11558,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -8748,60 +11658,104 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -8809,7 +11763,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -8847,8 +11803,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -9005,31 +11961,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -9037,40 +12016,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -9082,12 +12093,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -9103,22 +12120,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -9128,35 +12157,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -9164,70 +12219,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -9238,18 +12348,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -9269,20 +12388,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -9314,47 +12450,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -9367,36 +12530,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -9404,28 +12593,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -9437,12 +12657,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -9457,14 +12683,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -9475,10 +12701,21 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/products": { @@ -9522,7 +12759,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -9614,7 +12855,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -9625,17 +12869,17 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", - "rating", - "menu_order", + "popularity", "price", - "popularity", - "rating" + "rating", + "rating", + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -9701,13 +12945,25 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -9718,12 +12974,19 @@ }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -9732,17 +12995,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -9750,18 +13022,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -9775,7 +13056,11 @@ "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -9787,7 +13072,12 @@ "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -9796,18 +13086,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -9829,49 +13128,76 @@ "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -9890,17 +13216,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -9931,17 +13266,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -9973,46 +13317,82 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -10026,7 +13406,10 @@ "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "default": false, @@ -10044,20 +13427,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -10130,7 +13530,15 @@ "status": { "default": "publish", "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -10142,7 +13550,11 @@ "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -10151,18 +13563,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -10181,14 +13602,23 @@ "tax_status": { "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -10212,7 +13642,9 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { @@ -10246,7 +13678,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -10338,7 +13774,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -10349,17 +13788,17 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", - "rating", - "menu_order", + "popularity", "price", - "popularity", - "rating" + "rating", + "rating", + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -10425,13 +13864,25 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -10442,12 +13893,19 @@ }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -10456,17 +13914,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -10474,18 +13941,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -10499,7 +13975,11 @@ "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -10511,7 +13991,12 @@ "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -10520,18 +14005,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -10553,49 +14047,76 @@ "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -10614,17 +14135,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -10655,17 +14185,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -10697,46 +14236,82 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -10750,7 +14325,10 @@ "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "default": false, @@ -10768,20 +14346,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -10854,7 +14449,15 @@ "status": { "default": "publish", "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -10866,7 +14469,11 @@ "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -10875,18 +14482,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -10905,14 +14521,23 @@ "tax_status": { "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -10936,5496 +14561,1421 @@ "type": "string" } }, - "methods": ["POST"] - } - ], - "methods": ["GET", "POST", "GET", "POST"], - "namespace": "wc-analytics" - }, - "/wc-analytics/products/(?P\u003Cid\u003E[\\d]+)": { - "endpoints": [ - { - "args": { - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the resource.", - "required": false, - "type": "integer" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "options": { - "context": ["view", "edit"], - "description": "List of available term names of the attribute.", - "items": { - "type": "string" - }, - "type": "array" - }, - "position": { - "context": ["view", "edit"], - "description": "Attribute position.", - "type": "integer" - }, - "variation": { - "context": ["view", "edit"], - "default": false, - "description": "Define if the attribute can be used as variation.", - "type": "boolean" - }, - "visible": { - "context": ["view", "edit"], - "default": false, - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "required": false, - "type": "string" - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], - "required": false, - "type": "string" - }, - "categories": { - "description": "List of categories.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Category ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Category name.", - "readonly": true, - "type": "string" - }, - "slug": { - "context": ["view", "edit"], - "description": "Category slug.", - "readonly": true, - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "description": { - "description": "Product description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Product dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Product height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Product length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Product width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the product is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "format": "uri", - "required": false, - "type": "string" - }, - "featured": { - "description": "Featured product.", - "required": false, - "type": "boolean" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the resource.", - "required": false, - "type": "integer" - }, - "images": { - "description": "List of images.", - "items": { - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at product level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "post_password": { - "description": "Post password.", - "required": false, - "type": "string" - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "required": false, - "type": "string" - }, - "regular_price": { - "description": "Product regular price.", - "required": false, - "type": "string" - }, - "reviews_allowed": { - "description": "Allow reviews.", - "required": false, - "type": "boolean" - }, - "sale_price": { - "description": "Product sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "short_description": { - "description": "Product short description.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "slug": { - "description": "Product slug.", - "required": false, - "type": "string" - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "required": false, - "type": "boolean" - }, - "status": { - "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tags": { - "description": "List of tags.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Tag ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Tag name.", - "readonly": true, - "type": "string" - }, - "slug": { - "context": ["view", "edit"], - "description": "Tag slug.", - "readonly": true, - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], - "required": false, - "type": "string" - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "virtual": { - "description": "If the product is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Product weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST", "PUT", "PATCH"] - }, - { - "args": { - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "required": false, - "type": "boolean" - }, - "id": { - "description": "Unique identifier for the resource.", - "required": false, - "type": "integer" - } - }, - "methods": ["DELETE"] - }, - { - "args": { - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the resource.", - "required": false, - "type": "integer" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "options": { - "context": ["view", "edit"], - "description": "List of available term names of the attribute.", - "items": { - "type": "string" - }, - "type": "array" - }, - "position": { - "context": ["view", "edit"], - "description": "Attribute position.", - "type": "integer" - }, - "variation": { - "context": ["view", "edit"], - "default": false, - "description": "Define if the attribute can be used as variation.", - "type": "boolean" - }, - "visible": { - "context": ["view", "edit"], - "default": false, - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "required": false, - "type": "string" - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], - "required": false, - "type": "string" - }, - "categories": { - "description": "List of categories.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Category ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Category name.", - "readonly": true, - "type": "string" - }, - "slug": { - "context": ["view", "edit"], - "description": "Category slug.", - "readonly": true, - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "description": { - "description": "Product description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Product dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Product height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Product length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Product width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the product is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "format": "uri", - "required": false, - "type": "string" - }, - "featured": { - "description": "Featured product.", - "required": false, - "type": "boolean" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the resource.", - "required": false, - "type": "integer" - }, - "images": { - "description": "List of images.", - "items": { - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at product level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "post_password": { - "description": "Post password.", - "required": false, - "type": "string" - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "required": false, - "type": "string" - }, - "regular_price": { - "description": "Product regular price.", - "required": false, - "type": "string" - }, - "reviews_allowed": { - "description": "Allow reviews.", - "required": false, - "type": "boolean" - }, - "sale_price": { - "description": "Product sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "short_description": { - "description": "Product short description.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "slug": { - "description": "Product slug.", - "required": false, - "type": "string" - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "required": false, - "type": "boolean" - }, - "status": { - "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tags": { - "description": "List of tags.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Tag ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Tag name.", - "readonly": true, - "type": "string" - }, - "slug": { - "context": ["view", "edit"], - "description": "Tag slug.", - "readonly": true, - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], - "required": false, - "type": "string" - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "virtual": { - "description": "If the product is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Product weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST", "PUT", "PATCH"] - }, - { - "args": { - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "required": false, - "type": "boolean" - }, - "id": { - "description": "Unique identifier for the resource.", - "required": false, - "type": "integer" - } - }, - "methods": ["DELETE"] - } - ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE"], - "namespace": "wc-analytics" - }, - "/wc-analytics/products/(?P\u003Cid\u003E[\\d]+)/duplicate": { - "endpoints": [ - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "options": { - "context": ["view", "edit"], - "description": "List of available term names of the attribute.", - "items": { - "type": "string" - }, - "type": "array" - }, - "position": { - "context": ["view", "edit"], - "description": "Attribute position.", - "type": "integer" - }, - "variation": { - "context": ["view", "edit"], - "default": false, - "description": "Define if the attribute can be used as variation.", - "type": "boolean" - }, - "visible": { - "context": ["view", "edit"], - "default": false, - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "required": false, - "type": "string" - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], - "required": false, - "type": "string" - }, - "categories": { - "description": "List of categories.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Category ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Category name.", - "readonly": true, - "type": "string" - }, - "slug": { - "context": ["view", "edit"], - "description": "Category slug.", - "readonly": true, - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "description": { - "description": "Product description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Product dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Product height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Product length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Product width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the product is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "format": "uri", - "required": false, - "type": "string" - }, - "featured": { - "description": "Featured product.", - "required": false, - "type": "boolean" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the resource.", - "required": false, - "type": "integer" - }, - "images": { - "description": "List of images.", - "items": { - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at product level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "post_password": { - "description": "Post password.", - "required": false, - "type": "string" - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "required": false, - "type": "string" - }, - "regular_price": { - "description": "Product regular price.", - "required": false, - "type": "string" - }, - "reviews_allowed": { - "description": "Allow reviews.", - "required": false, - "type": "boolean" - }, - "sale_price": { - "description": "Product sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "short_description": { - "description": "Product short description.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "slug": { - "description": "Product slug.", - "required": false, - "type": "string" - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "required": false, - "type": "boolean" - }, - "status": { - "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tags": { - "description": "List of tags.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Tag ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Tag name.", - "readonly": true, - "type": "string" - }, - "slug": { - "context": ["view", "edit"], - "description": "Tag slug.", - "readonly": true, - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], - "required": false, - "type": "string" - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "virtual": { - "description": "If the product is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Product weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "options": { - "context": ["view", "edit"], - "description": "List of available term names of the attribute.", - "items": { - "type": "string" - }, - "type": "array" - }, - "position": { - "context": ["view", "edit"], - "description": "Attribute position.", - "type": "integer" - }, - "variation": { - "context": ["view", "edit"], - "default": false, - "description": "Define if the attribute can be used as variation.", - "type": "boolean" - }, - "visible": { - "context": ["view", "edit"], - "default": false, - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "required": false, - "type": "string" - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], - "required": false, - "type": "string" - }, - "categories": { - "description": "List of categories.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Category ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Category name.", - "readonly": true, - "type": "string" - }, - "slug": { - "context": ["view", "edit"], - "description": "Category slug.", - "readonly": true, - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "description": { - "description": "Product description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Product dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Product height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Product length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Product width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the product is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "format": "uri", - "required": false, - "type": "string" - }, - "featured": { - "description": "Featured product.", - "required": false, - "type": "boolean" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the resource.", - "required": false, - "type": "integer" - }, - "images": { - "description": "List of images.", - "items": { - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at product level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "post_password": { - "description": "Post password.", - "required": false, - "type": "string" - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "required": false, - "type": "string" - }, - "regular_price": { - "description": "Product regular price.", - "required": false, - "type": "string" - }, - "reviews_allowed": { - "description": "Allow reviews.", - "required": false, - "type": "boolean" - }, - "sale_price": { - "description": "Product sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "short_description": { - "description": "Product short description.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "slug": { - "description": "Product slug.", - "required": false, - "type": "string" - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "required": false, - "type": "boolean" - }, - "status": { - "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tags": { - "description": "List of tags.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Tag ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Tag name.", - "readonly": true, - "type": "string" - }, - "slug": { - "context": ["view", "edit"], - "description": "Tag slug.", - "readonly": true, - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], - "required": false, - "type": "string" - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "virtual": { - "description": "If the product is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Product weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST"] - } - ], - "methods": ["POST", "POST"], - "namespace": "wc-analytics" - }, - "/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations": { - "endpoints": [ - { - "args": { - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "items": { - "properties": { - "attribute": { - "description": "Attribute slug.", - "type": "string" - }, - "term": { - "description": "Attribute term.", - "type": "string" - }, - "terms": { - "description": "Attribute terms.", - "type": "array" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], - "required": false, - "type": "string" - }, - "dates_are_gmt": { - "default": false, - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "type": "boolean" - }, - "exclude": { - "default": [], - "description": "Ensure result set excludes specific IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "items": { - "type": "string" - }, - "required": false, - "type": "array" - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "required": false, - "type": "boolean" - }, - "include": { - "default": [], - "description": "Limit result set to specific ids.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "items": { - "type": "string" - }, - "required": false, - "type": "array" - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "required": false, - "type": "string" - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "required": false, - "type": "string" - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "required": false, - "type": "integer" - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "required": false, - "type": "boolean" - }, - "order": { - "default": "desc", - "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], - "required": false, - "type": "string" - }, - "orderby": { - "default": "date", - "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], - "required": false, - "type": "string" - }, - "page": { - "default": 1, - "description": "Current page of the collection.", - "minimum": 1, - "required": false, - "type": "integer" - }, - "parent": { - "default": [], - "description": "Limit result set to those of particular parent IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "parent_exclude": { - "default": [], - "description": "Limit result set to all items except those of a particular parent ID.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "per_page": { - "default": 10, - "description": "Maximum number of items to be returned in result set.", - "maximum": 100, - "minimum": 1, - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "type": "string" - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "required": false, - "type": "string" - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "default": "publish", - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "default": "variation", - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST"] - }, - { - "args": { - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "items": { - "properties": { - "attribute": { - "description": "Attribute slug.", - "type": "string" - }, - "term": { - "description": "Attribute term.", - "type": "string" - }, - "terms": { - "description": "Attribute terms.", - "type": "array" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], - "required": false, - "type": "string" - }, - "dates_are_gmt": { - "default": false, - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "type": "boolean" - }, - "exclude": { - "default": [], - "description": "Ensure result set excludes specific IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "items": { - "type": "string" - }, - "required": false, - "type": "array" - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "required": false, - "type": "boolean" - }, - "include": { - "default": [], - "description": "Limit result set to specific ids.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "items": { - "type": "string" - }, - "required": false, - "type": "array" - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "required": false, - "type": "string" - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "required": false, - "type": "string" - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "required": false, - "type": "integer" - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "required": false, - "type": "boolean" - }, - "order": { - "default": "desc", - "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], - "required": false, - "type": "string" - }, - "orderby": { - "default": "date", - "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], - "required": false, - "type": "string" - }, - "page": { - "default": 1, - "description": "Current page of the collection.", - "minimum": 1, - "required": false, - "type": "integer" - }, - "parent": { - "default": [], - "description": "Limit result set to those of particular parent IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "parent_exclude": { - "default": [], - "description": "Limit result set to all items except those of a particular parent ID.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "per_page": { - "default": 10, - "description": "Maximum number of items to be returned in result set.", - "maximum": 100, - "minimum": 1, - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "type": "string" - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "required": false, - "type": "string" - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "default": "publish", - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "default": "variation", - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST"] - }, - { - "args": { - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "items": { - "properties": { - "attribute": { - "description": "Attribute slug.", - "type": "string" - }, - "term": { - "description": "Attribute term.", - "type": "string" - }, - "terms": { - "description": "Attribute terms.", - "type": "array" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], - "required": false, - "type": "string" - }, - "dates_are_gmt": { - "default": false, - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "type": "boolean" - }, - "exclude": { - "default": [], - "description": "Ensure result set excludes specific IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "items": { - "type": "string" - }, - "required": false, - "type": "array" - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "required": false, - "type": "boolean" - }, - "include": { - "default": [], - "description": "Limit result set to specific ids.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "items": { - "type": "string" - }, - "required": false, - "type": "array" - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "required": false, - "type": "string" - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "required": false, - "type": "string" - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "required": false, - "type": "integer" - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "required": false, - "type": "boolean" - }, - "order": { - "default": "desc", - "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], - "required": false, - "type": "string" - }, - "orderby": { - "default": "date", - "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], - "required": false, - "type": "string" - }, - "page": { - "default": 1, - "description": "Current page of the collection.", - "minimum": 1, - "required": false, - "type": "integer" - }, - "parent": { - "default": [], - "description": "Limit result set to those of particular parent IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "parent_exclude": { - "default": [], - "description": "Limit result set to all items except those of a particular parent ID.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "per_page": { - "default": 10, - "description": "Maximum number of items to be returned in result set.", - "maximum": 100, - "minimum": 1, - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "type": "string" - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "required": false, - "type": "string" - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "default": "publish", - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "default": "variation", - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST"] - }, - { - "args": { - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "items": { - "properties": { - "attribute": { - "description": "Attribute slug.", - "type": "string" - }, - "term": { - "description": "Attribute term.", - "type": "string" - }, - "terms": { - "description": "Attribute terms.", - "type": "array" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], - "required": false, - "type": "string" - }, - "dates_are_gmt": { - "default": false, - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "type": "boolean" - }, - "exclude": { - "default": [], - "description": "Ensure result set excludes specific IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "items": { - "type": "string" - }, - "required": false, - "type": "array" - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "required": false, - "type": "boolean" - }, - "include": { - "default": [], - "description": "Limit result set to specific ids.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "items": { - "type": "string" - }, - "required": false, - "type": "array" - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "required": false, - "type": "string" - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "required": false, - "type": "string" - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "format": "date-time", - "required": false, - "type": "string" - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "required": false, - "type": "integer" - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "required": false, - "type": "boolean" - }, - "order": { - "default": "desc", - "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], - "required": false, - "type": "string" - }, - "orderby": { - "default": "date", - "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], - "required": false, - "type": "string" - }, - "page": { - "default": 1, - "description": "Current page of the collection.", - "minimum": 1, - "required": false, - "type": "integer" - }, - "parent": { - "default": [], - "description": "Limit result set to those of particular parent IDs.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "parent_exclude": { - "default": [], - "description": "Limit result set to all items except those of a particular parent ID.", - "items": { - "type": "integer" - }, - "required": false, - "type": "array" - }, - "per_page": { - "default": 10, - "description": "Maximum number of items to be returned in result set.", - "maximum": 100, - "minimum": 1, - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "type": "string" - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "required": false, - "type": "string" - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "default": "publish", - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "default": "variation", - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST"] - } - ], - "methods": ["GET", "POST", "GET", "POST", "GET", "POST", "GET", "POST"], - "namespace": "wc-analytics" - }, - "/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/(?P\u003Cid\u003E[\\d]+)": { - "endpoints": [ - { - "args": { - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST", "PUT", "PATCH"] - }, - { - "args": { - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "required": false, - "type": "boolean" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - } - }, - "methods": ["DELETE"] - }, - { - "args": { - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST", "PUT", "PATCH"] - }, - { - "args": { - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "required": false, - "type": "boolean" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - } - }, - "methods": ["DELETE"] - }, - { - "args": { - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST", "PUT", "PATCH"] - }, - { - "args": { - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "required": false, - "type": "boolean" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - } - }, - "methods": ["DELETE"] - }, - { - "args": { - "context": { - "default": "view", - "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - } - }, - "methods": ["GET"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST", "PUT", "PATCH"] - }, - { - "args": { - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "required": false, - "type": "boolean" - }, - "id": { - "description": "Unique identifier for the variation.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - } - }, - "methods": ["DELETE"] + "methods": [ + "POST" + ] } ], "methods": [ "GET", - "POST", - "PUT", - "PATCH", - "DELETE", "GET", "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" + "POST" ], "namespace": "wc-analytics" }, - "/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/batch": { + "/wc-analytics/products/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "options": { + "context": [ + "edit", + "view" + ], + "description": "List of available term names of the attribute.", + "items": { + "type": "string" + }, + "type": "array" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Attribute position.", + "type": "integer" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Define if the attribute can be used as variation.", + "type": "boolean" + }, + "visible": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", + "type": "boolean" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "button_text": { + "description": "Product external button text. Only for external products.", + "required": false, + "type": "string" + }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], + "required": false, + "type": "string" + }, + "categories": { + "description": "List of categories.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Category ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Category slug.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "date_created": { + "description": "The date the product was created, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "description": { + "description": "Product description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Product height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Product length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Product width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "description": "If the product is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "external_url": { + "description": "Product external URL. Only for external products.", + "format": "uri", + "required": false, + "type": "string" + }, + "featured": { + "description": "Featured product.", + "required": false, + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "images": { + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "required": false, + "type": "string" + }, + "purchase_note": { + "description": "Optional note to send the customer after purchase.", + "required": false, + "type": "string" + }, + "regular_price": { + "description": "Product regular price.", + "required": false, + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "required": false, + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Product slug.", + "required": false, + "type": "string" + }, + "sold_individually": { + "description": "Allow one item to be bought in a single order.", + "required": false, + "type": "boolean" + }, + "status": { + "description": "Product status (post status).", + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tags": { + "description": "List of tags.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tag ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tag name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Tag slug.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Product type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "required": false, + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "options": { + "context": [ + "edit", + "view" + ], + "description": "List of available term names of the attribute.", + "items": { + "type": "string" + }, + "type": "array" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Attribute position.", + "type": "integer" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Define if the attribute can be used as variation.", + "type": "boolean" + }, + "visible": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", + "type": "boolean" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "button_text": { + "description": "Product external button text. Only for external products.", + "required": false, + "type": "string" + }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], + "required": false, + "type": "string" + }, + "categories": { + "description": "List of categories.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Category ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Category slug.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "date_created": { + "description": "The date the product was created, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "description": { + "description": "Product description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Product dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Product height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Product length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Product width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "description": "If the product is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "external_url": { + "description": "Product external URL. Only for external products.", + "format": "uri", + "required": false, + "type": "string" + }, + "featured": { + "description": "Featured product.", + "required": false, + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "images": { + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at product level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "post_password": { + "description": "Post password.", + "required": false, + "type": "string" + }, + "purchase_note": { + "description": "Optional note to send the customer after purchase.", + "required": false, + "type": "string" + }, + "regular_price": { + "description": "Product regular price.", + "required": false, + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "required": false, + "type": "boolean" + }, + "sale_price": { + "description": "Product sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "short_description": { + "description": "Product short description.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Product slug.", + "required": false, + "type": "string" + }, + "sold_individually": { + "description": "Allow one item to be bought in a single order.", + "required": false, + "type": "boolean" + }, + "status": { + "description": "Product status (post status).", + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tags": { + "description": "List of tags.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tag ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tag name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Tag slug.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Product type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "required": false, + "type": "string" + }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "virtual": { + "description": "If the product is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "DELETE", + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/(?P[\\d]+)/duplicate": { "endpoints": [ { "args": { @@ -16434,19 +15984,57 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" + "options": { + "context": [ + "edit", + "view" + ], + "description": "List of available term names of the attribute.", + "items": { + "type": "string" + }, + "type": "array" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Attribute position.", + "type": "integer" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Define if the attribute can be used as variation.", + "type": "boolean" + }, + "visible": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", + "type": "boolean" } }, "type": "object" @@ -16456,51 +16044,186 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, + "button_text": { + "description": "Product external button text. Only for external products.", + "required": false, + "type": "string" + }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], + "required": false, + "type": "string" + }, + "categories": { + "description": "List of categories.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Category ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Category slug.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "date_created": { + "description": "The date the product was created, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" }, "description": { - "description": "Variation description.", + "description": "Product description.", "required": false, "type": "string" }, "dimensions": { - "description": "Variation dimensions.", + "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", + "context": [ + "edit", + "view" + ], + "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", + "context": [ + "edit", + "view" + ], + "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", + "context": [ + "edit", + "view" + ], + "description": "Product width (cm).", "type": "string" } }, @@ -16518,7 +16241,7 @@ "type": "integer" }, "downloadable": { - "description": "If the variation is downloadable.", + "description": "If the product is downloadable.", "required": false, "type": "boolean" }, @@ -16527,17 +16250,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -16547,70 +16279,128 @@ "required": false, "type": "array" }, + "external_url": { + "description": "Product external URL. Only for external products.", + "format": "uri", + "required": false, + "type": "string" + }, + "featured": { + "description": "Featured product.", + "required": false, + "type": "boolean" + }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "images": { + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } + "type": "object" }, "required": false, - "type": "object" + "type": "array" }, "low_stock_amount": { - "description": "Low Stock amount for the variation.", + "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { - "description": "Stock management at variation level.", + "description": "Stock management at product level.", "required": false, "type": "boolean" }, @@ -16624,20 +16414,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -16646,7 +16453,7 @@ "type": "array" }, "name": { - "description": "Product parent name.", + "description": "Product name.", "required": false, "type": "string" }, @@ -16655,18 +16462,28 @@ "required": false, "type": "integer" }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", + "post_password": { + "description": "Post password.", "required": false, "type": "string" }, + "purchase_note": { + "description": "Optional note to send the customer after purchase.", + "required": false, + "type": "string" + }, + "regular_price": { + "description": "Product regular price.", + "required": false, + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "required": false, + "type": "boolean" + }, "sale_price": { - "description": "Variation sale price.", + "description": "Product sale price.", "required": false, "type": "string" }, @@ -16675,14 +16492,37 @@ "required": false, "type": "string" }, + "short_description": { + "description": "Product short description.", + "required": false, + "type": "string" + }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, + "slug": { + "description": "Product slug.", + "required": false, + "type": "string" + }, + "sold_individually": { + "description": "Allow one item to be bought in a single order.", + "required": false, + "type": "boolean" + }, "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "description": "Product status (post status).", + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -16693,10 +16533,50 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, + "tags": { + "description": "List of tags.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tag ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tag name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Tag slug.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, "tax_class": { "description": "Tax class.", "required": false, @@ -16704,28 +16584,47 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["variation"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, "virtual": { - "description": "If the variation is virtual.", + "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { - "description": "Variation weight (kg).", + "description": "Product weight (kg).", "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "POST" + ] }, { "args": { @@ -16734,19 +16633,57 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" + "options": { + "context": [ + "edit", + "view" + ], + "description": "List of available term names of the attribute.", + "items": { + "type": "string" + }, + "type": "array" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Attribute position.", + "type": "integer" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Define if the attribute can be used as variation.", + "type": "boolean" + }, + "visible": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", + "type": "boolean" } }, "type": "object" @@ -16756,51 +16693,186 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, + "button_text": { + "description": "Product external button text. Only for external products.", + "required": false, + "type": "string" + }, + "catalog_visibility": { + "description": "Catalogue visibility.", + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], + "required": false, + "type": "string" + }, + "categories": { + "description": "List of categories.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Category ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Category slug.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "cross_sell_ids": { + "description": "List of cross-sell products IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "date_created": { + "description": "The date the product was created, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] + }, + "default_attributes": { + "description": "Defaults variation attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" }, "description": { - "description": "Variation description.", + "description": "Product description.", "required": false, "type": "string" }, "dimensions": { - "description": "Variation dimensions.", + "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", + "context": [ + "edit", + "view" + ], + "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", + "context": [ + "edit", + "view" + ], + "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", + "context": [ + "edit", + "view" + ], + "description": "Product width (cm).", "type": "string" } }, @@ -16818,7 +16890,7 @@ "type": "integer" }, "downloadable": { - "description": "If the variation is downloadable.", + "description": "If the product is downloadable.", "required": false, "type": "boolean" }, @@ -16827,17 +16899,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -16847,70 +16928,128 @@ "required": false, "type": "array" }, + "external_url": { + "description": "Product external URL. Only for external products.", + "format": "uri", + "required": false, + "type": "string" + }, + "featured": { + "description": "Featured product.", + "required": false, + "type": "boolean" + }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "images": { + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } + "type": "object" }, "required": false, - "type": "object" + "type": "array" }, "low_stock_amount": { - "description": "Low Stock amount for the variation.", + "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { - "description": "Stock management at variation level.", + "description": "Stock management at product level.", "required": false, "type": "boolean" }, @@ -16924,20 +17063,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -16946,7 +17102,7 @@ "type": "array" }, "name": { - "description": "Product parent name.", + "description": "Product name.", "required": false, "type": "string" }, @@ -16955,18 +17111,28 @@ "required": false, "type": "integer" }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", + "post_password": { + "description": "Post password.", "required": false, "type": "string" }, + "purchase_note": { + "description": "Optional note to send the customer after purchase.", + "required": false, + "type": "string" + }, + "regular_price": { + "description": "Product regular price.", + "required": false, + "type": "string" + }, + "reviews_allowed": { + "description": "Allow reviews.", + "required": false, + "type": "boolean" + }, "sale_price": { - "description": "Variation sale price.", + "description": "Product sale price.", "required": false, "type": "string" }, @@ -16975,14 +17141,37 @@ "required": false, "type": "string" }, + "short_description": { + "description": "Product short description.", + "required": false, + "type": "string" + }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, + "slug": { + "description": "Product slug.", + "required": false, + "type": "string" + }, + "sold_individually": { + "description": "Allow one item to be bought in a single order.", + "required": false, + "type": "boolean" + }, "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "description": "Product status (post status).", + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -16993,551 +17182,43 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST", "PUT", "PATCH"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", + "tags": { + "description": "List of tags.", "items": { "properties": { "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", + "context": [ + "edit", + "view" + ], + "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", + "context": [ + "edit", + "view" + ], + "description": "Tag name.", "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", "type": "string" }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, - "tax_class": { - "description": "Tax class.", - "required": false, - "type": "string" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "required": false, - "type": "string" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "required": false, - "type": "string" - }, - "virtual": { - "description": "If the variation is virtual.", - "required": false, - "type": "boolean" - }, - "weight": { - "description": "Variation weight (kg).", - "required": false, - "type": "string" - } - }, - "methods": ["POST", "PUT", "PATCH"] - }, - { - "args": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "required": false, - "type": "string" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "required": false, - "type": ["null", "string"] - }, - "description": { - "description": "Variation description.", - "required": false, - "type": "string" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "required": false, - "type": "integer" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "required": false, - "type": "integer" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "required": false, - "type": "boolean" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "required": false, - "type": "array" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "required": false, - "type": "string" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "required": false, - "type": "object" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "required": false, - "type": ["integer", "null"] - }, - "manage_stock": { - "description": "Stock management at variation level.", - "required": false, - "type": "boolean" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "required": false, - "type": "integer" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Tag slug.", "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] } }, "type": "object" @@ -17545,58 +17226,6 @@ "required": false, "type": "array" }, - "name": { - "description": "Product parent name.", - "required": false, - "type": "string" - }, - "parent_id": { - "description": "Product parent ID.", - "required": false, - "type": "integer" - }, - "product_id": { - "description": "Unique identifier for the variable product.", - "required": false, - "type": "integer" - }, - "regular_price": { - "description": "Variation regular price.", - "required": false, - "type": "string" - }, - "sale_price": { - "description": "Variation sale price.", - "required": false, - "type": "string" - }, - "shipping_class": { - "description": "Shipping class slug.", - "required": false, - "type": "string" - }, - "sku": { - "description": "Stock Keeping Unit.", - "required": false, - "type": "string" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "required": false, - "type": "string" - }, - "stock_quantity": { - "description": "Stock quantity.", - "required": false, - "type": "integer" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "required": false, - "type": "string" - }, "tax_class": { "description": "Tax class.", "required": false, @@ -17604,34 +17233,4626 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["variation"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, + "upsell_ids": { + "description": "List of up-sell products IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, "virtual": { - "description": "If the variation is virtual.", + "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { - "description": "Variation weight (kg).", + "description": "Product weight (kg).", "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "POST" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH", "POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "POST", + "POST" + ], "namespace": "wc-analytics" }, - "/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/generate": { + "/wc-analytics/products/(?P[\\d]+)/variations": { + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attributes": { + "description": "Limit result set to products with specified attributes.", + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "dates_are_gmt": { + "default": false, + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "required": false, + "type": "boolean" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "exclude_meta": { + "default": [], + "description": "Ensure meta_data excludes specific keys.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "has_price": { + "description": "Limit result set to products with or without price.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include_meta": { + "default": [], + "description": "Limit meta_data to specific keys.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "max_price": { + "description": "Limit result set to products based on a maximum price.", + "required": false, + "type": "string" + }, + "min_price": { + "description": "Limit result set to products based on a minimum price.", + "required": false, + "type": "string" + }, + "modified_after": { + "description": "Limit response to resources modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "modified_before": { + "description": "Limit response to resources modified before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "on_sale": { + "description": "Limit result set to products on sale.", + "required": false, + "type": "boolean" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "default": [], + "description": "Limit result set to those of particular parent IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "parent_exclude": { + "default": [], + "description": "Limit result set to all items except those of a particular parent ID.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Search by similar product name, SKU, or attribute value.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to products with a specific slug.", + "required": false, + "type": "string" + }, + "status": { + "default": "any", + "description": "Limit result set to products assigned a specific status.", + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], + "required": false, + "type": "string" + }, + "stock_status": { + "description": "Limit result set to products with specified stock status.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "default": false, + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "default": false, + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "default": "instock", + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "variation", + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "default": false, + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attributes": { + "description": "Limit result set to products with specified attributes.", + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "dates_are_gmt": { + "default": false, + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "required": false, + "type": "boolean" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "exclude_meta": { + "default": [], + "description": "Ensure meta_data excludes specific keys.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "has_price": { + "description": "Limit result set to products with or without price.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include_meta": { + "default": [], + "description": "Limit meta_data to specific keys.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "max_price": { + "description": "Limit result set to products based on a maximum price.", + "required": false, + "type": "string" + }, + "min_price": { + "description": "Limit result set to products based on a minimum price.", + "required": false, + "type": "string" + }, + "modified_after": { + "description": "Limit response to resources modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "modified_before": { + "description": "Limit response to resources modified before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "on_sale": { + "description": "Limit result set to products on sale.", + "required": false, + "type": "boolean" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "default": [], + "description": "Limit result set to those of particular parent IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "parent_exclude": { + "default": [], + "description": "Limit result set to all items except those of a particular parent ID.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Search by similar product name, SKU, or attribute value.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to products with a specific slug.", + "required": false, + "type": "string" + }, + "status": { + "default": "any", + "description": "Limit result set to products assigned a specific status.", + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], + "required": false, + "type": "string" + }, + "stock_status": { + "description": "Limit result set to products with specified stock status.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "default": false, + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "default": false, + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "default": "instock", + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "variation", + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "default": false, + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attributes": { + "description": "Limit result set to products with specified attributes.", + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "dates_are_gmt": { + "default": false, + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "required": false, + "type": "boolean" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "exclude_meta": { + "default": [], + "description": "Ensure meta_data excludes specific keys.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "has_price": { + "description": "Limit result set to products with or without price.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include_meta": { + "default": [], + "description": "Limit meta_data to specific keys.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "max_price": { + "description": "Limit result set to products based on a maximum price.", + "required": false, + "type": "string" + }, + "min_price": { + "description": "Limit result set to products based on a minimum price.", + "required": false, + "type": "string" + }, + "modified_after": { + "description": "Limit response to resources modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "modified_before": { + "description": "Limit response to resources modified before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "on_sale": { + "description": "Limit result set to products on sale.", + "required": false, + "type": "boolean" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "default": [], + "description": "Limit result set to those of particular parent IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "parent_exclude": { + "default": [], + "description": "Limit result set to all items except those of a particular parent ID.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Search by similar product name, SKU, or attribute value.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to products with a specific slug.", + "required": false, + "type": "string" + }, + "status": { + "default": "any", + "description": "Limit result set to products assigned a specific status.", + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], + "required": false, + "type": "string" + }, + "stock_status": { + "description": "Limit result set to products with specified stock status.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "default": false, + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "default": false, + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "default": "instock", + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "variation", + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "default": false, + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attributes": { + "description": "Limit result set to products with specified attributes.", + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "dates_are_gmt": { + "default": false, + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "required": false, + "type": "boolean" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "exclude_meta": { + "default": [], + "description": "Ensure meta_data excludes specific keys.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "has_price": { + "description": "Limit result set to products with or without price.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include_meta": { + "default": [], + "description": "Limit meta_data to specific keys.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "max_price": { + "description": "Limit result set to products based on a maximum price.", + "required": false, + "type": "string" + }, + "min_price": { + "description": "Limit result set to products based on a minimum price.", + "required": false, + "type": "string" + }, + "modified_after": { + "description": "Limit response to resources modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "modified_before": { + "description": "Limit response to resources modified before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "on_sale": { + "description": "Limit result set to products on sale.", + "required": false, + "type": "boolean" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "default": [], + "description": "Limit result set to those of particular parent IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "parent_exclude": { + "default": [], + "description": "Limit result set to all items except those of a particular parent ID.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Search by similar product name, SKU, or attribute value.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to products with a specific slug.", + "required": false, + "type": "string" + }, + "status": { + "default": "any", + "description": "Limit result set to products assigned a specific status.", + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], + "required": false, + "type": "string" + }, + "stock_status": { + "description": "Limit result set to products with specified stock status.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "default": false, + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "default": false, + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "default": "instock", + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "variation", + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "default": false, + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "GET", + "GET", + "GET", + "POST", + "POST", + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/(?P[\\d]+)/variations/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "DELETE", + "DELETE", + "DELETE", + "GET", + "GET", + "GET", + "GET", + "PATCH", + "PATCH", + "PATCH", + "PATCH", + "POST", + "POST", + "POST", + "POST", + "PUT", + "PUT", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/(?P[\\d]+)/variations/batch": { "endpoints": [ { "args": { @@ -17640,17 +21861,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -17661,365 +21891,46 @@ "type": "array" }, "backorders": { - "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] - }, - "default_values": { - "description": "Default values for generated variations.", - "properties": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "description": { - "description": "Variation description.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "object", - "validate_callback": "rest_validate_request_arg" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "object", - "validate_callback": "rest_validate_request_arg" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["integer", "null"], - "validate_callback": "rest_validate_request_arg" - }, - "manage_stock": { - "description": "Stock management at variation level.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "name": { - "description": "Product parent name.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "parent_id": { - "description": "Product parent ID.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "regular_price": { - "description": "Variation regular price.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "sale_price": { - "description": "Variation sale price.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "shipping_class": { - "description": "Shipping class slug.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "sku": { - "description": "Stock Keeping Unit.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "stock_quantity": { - "description": "Stock quantity.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "tax_class": { - "description": "Tax class.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "virtual": { - "description": "If the variation is virtual.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "weight": { - "description": "Variation weight (kg).", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - } - }, - "required": false, - "type": "object" - }, - "delete": { - "description": "Deletes unused variations.", - "required": false, - "type": "boolean" + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -18030,17 +21941,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -18049,19 +21969,16 @@ "type": "object" }, "download_expiry": { - "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { - "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { - "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" @@ -18071,17 +21988,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -18100,46 +22026,82 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -18151,10 +22113,12 @@ "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { - "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" @@ -18169,20 +22133,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -18226,9 +22207,13 @@ "type": "string" }, "status": { - "default": "publish", "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "enum": [ + "draft", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -18238,9 +22223,12 @@ "type": "integer" }, "stock_status": { - "default": "instock", "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -18250,21 +22238,24 @@ "type": "string" }, "tax_status": { - "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { - "default": "variation", "description": "Product type.", - "enum": ["variation"], + "enum": [ + "variation" + ], "required": false, "type": "string" }, "virtual": { - "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" @@ -18275,7 +22266,11 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -18284,17 +22279,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -18305,365 +22309,46 @@ "type": "array" }, "backorders": { - "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] - }, - "default_values": { - "description": "Default values for generated variations.", - "properties": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "description": { - "description": "Variation description.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "object", - "validate_callback": "rest_validate_request_arg" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "object", - "validate_callback": "rest_validate_request_arg" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["integer", "null"], - "validate_callback": "rest_validate_request_arg" - }, - "manage_stock": { - "description": "Stock management at variation level.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "name": { - "description": "Product parent name.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "parent_id": { - "description": "Product parent ID.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "regular_price": { - "description": "Variation regular price.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "sale_price": { - "description": "Variation sale price.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "shipping_class": { - "description": "Shipping class slug.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "sku": { - "description": "Stock Keeping Unit.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "stock_quantity": { - "description": "Stock quantity.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "tax_class": { - "description": "Tax class.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "virtual": { - "description": "If the variation is virtual.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "weight": { - "description": "Variation weight (kg).", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - } - }, - "required": false, - "type": "object" - }, - "delete": { - "description": "Deletes unused variations.", - "required": false, - "type": "boolean" + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -18674,17 +22359,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -18693,19 +22387,16 @@ "type": "object" }, "download_expiry": { - "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { - "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { - "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" @@ -18715,17 +22406,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -18744,46 +22444,82 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -18795,10 +22531,12 @@ "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { - "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" @@ -18813,20 +22551,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -18870,9 +22625,13 @@ "type": "string" }, "status": { - "default": "publish", "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "enum": [ + "draft", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -18882,9 +22641,12 @@ "type": "integer" }, "stock_status": { - "default": "instock", "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -18894,21 +22656,24 @@ "type": "string" }, "tax_status": { - "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { - "default": "variation", "description": "Product type.", - "enum": ["variation"], + "enum": [ + "variation" + ], "required": false, "type": "string" }, "virtual": { - "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" @@ -18919,7 +22684,11 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -18928,17 +22697,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -18949,365 +22727,46 @@ "type": "array" }, "backorders": { - "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] - }, - "default_values": { - "description": "Default values for generated variations.", - "properties": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "description": { - "description": "Variation description.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "object", - "validate_callback": "rest_validate_request_arg" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "object", - "validate_callback": "rest_validate_request_arg" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["integer", "null"], - "validate_callback": "rest_validate_request_arg" - }, - "manage_stock": { - "description": "Stock management at variation level.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "name": { - "description": "Product parent name.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "parent_id": { - "description": "Product parent ID.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "regular_price": { - "description": "Variation regular price.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "sale_price": { - "description": "Variation sale price.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "shipping_class": { - "description": "Shipping class slug.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "sku": { - "description": "Stock Keeping Unit.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "stock_quantity": { - "description": "Stock quantity.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "tax_class": { - "description": "Tax class.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "virtual": { - "description": "If the variation is virtual.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "weight": { - "description": "Variation weight (kg).", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - } - }, - "required": false, - "type": "object" - }, - "delete": { - "description": "Deletes unused variations.", - "required": false, - "type": "boolean" + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -19318,17 +22777,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -19337,19 +22805,16 @@ "type": "object" }, "download_expiry": { - "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { - "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { - "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" @@ -19359,17 +22824,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -19388,46 +22862,82 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -19439,10 +22949,12 @@ "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { - "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" @@ -19457,20 +22969,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -19514,9 +23043,13 @@ "type": "string" }, "status": { - "default": "publish", "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "enum": [ + "draft", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -19526,9 +23059,12 @@ "type": "integer" }, "stock_status": { - "default": "instock", "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -19538,21 +23074,24 @@ "type": "string" }, "tax_status": { - "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { - "default": "variation", "description": "Product type.", - "enum": ["variation"], + "enum": [ + "variation" + ], "required": false, "type": "string" }, "virtual": { - "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" @@ -19563,7 +23102,11 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -19572,17 +23115,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -19593,365 +23145,46 @@ "type": "array" }, "backorders": { - "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] - }, - "default_values": { - "description": "Default values for generated variations.", - "properties": { - "attributes": { - "description": "List of attributes.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Attribute ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Attribute name.", - "type": "string" - }, - "option": { - "context": ["view", "edit"], - "description": "Selected attribute term name.", - "type": "string" - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], - "validate_callback": "rest_validate_request_arg" - }, - "description": { - "description": "Variation description.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "dimensions": { - "description": "Variation dimensions.", - "properties": { - "height": { - "context": ["view", "edit"], - "description": "Variation height (cm).", - "type": "string" - }, - "length": { - "context": ["view", "edit"], - "description": "Variation length (cm).", - "type": "string" - }, - "width": { - "context": ["view", "edit"], - "description": "Variation width (cm).", - "type": "string" - } - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "object", - "validate_callback": "rest_validate_request_arg" - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "downloadable": { - "description": "If the variation is downloadable.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "downloads": { - "description": "List of downloadable files.", - "items": { - "properties": { - "file": { - "context": ["view", "edit"], - "description": "File URL.", - "type": "string" - }, - "id": { - "context": ["view", "edit"], - "description": "File ID.", - "type": "string" - }, - "name": { - "context": ["view", "edit"], - "description": "File name.", - "type": "string" - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "image": { - "description": "Variation image data.", - "properties": { - "alt": { - "context": ["view", "edit"], - "description": "Image alternative text.", - "type": "string" - }, - "date_created": { - "context": ["view", "edit"], - "description": "The date the image was created, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_created_gmt": { - "context": ["view", "edit"], - "description": "The date the image was created, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified": { - "context": ["view", "edit"], - "description": "The date the image was last modified, in the site's timezone.", - "readonly": true, - "type": ["null", "string"] - }, - "date_modified_gmt": { - "context": ["view", "edit"], - "description": "The date the image was last modified, as GMT.", - "readonly": true, - "type": ["null", "string"] - }, - "id": { - "context": ["view", "edit"], - "description": "Image ID.", - "type": "integer" - }, - "name": { - "context": ["view", "edit"], - "description": "Image name.", - "type": "string" - }, - "src": { - "context": ["view", "edit"], - "description": "Image URL.", - "format": "uri", - "type": "string" - } - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "object", - "validate_callback": "rest_validate_request_arg" - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": ["integer", "null"], - "validate_callback": "rest_validate_request_arg" - }, - "manage_stock": { - "description": "Stock management at variation level.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "meta_data": { - "description": "Meta data.", - "items": { - "properties": { - "id": { - "context": ["view", "edit"], - "description": "Meta ID.", - "readonly": true, - "type": "integer" - }, - "key": { - "context": ["view", "edit"], - "description": "Meta key.", - "type": "string" - }, - "value": { - "context": ["view", "edit"], - "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] - } - }, - "type": "object" - }, - "sanitize_callback": "rest_sanitize_request_arg", - "type": "array", - "validate_callback": "rest_validate_request_arg" - }, - "name": { - "description": "Product parent name.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "parent_id": { - "description": "Product parent ID.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "regular_price": { - "description": "Variation regular price.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "sale_price": { - "description": "Variation sale price.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "shipping_class": { - "description": "Shipping class slug.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "sku": { - "description": "Stock Keeping Unit.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "status": { - "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "stock_quantity": { - "description": "Stock quantity.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "integer", - "validate_callback": "rest_validate_request_arg" - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "tax_class": { - "description": "Tax class.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "tax_status": { - "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "type": { - "description": "Product type.", - "enum": ["variation"], - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - }, - "virtual": { - "description": "If the variation is virtual.", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "boolean", - "validate_callback": "rest_validate_request_arg" - }, - "weight": { - "description": "Variation weight (kg).", - "sanitize_callback": "rest_sanitize_request_arg", - "type": "string", - "validate_callback": "rest_validate_request_arg" - } - }, - "required": false, - "type": "object" - }, - "delete": { - "description": "Deletes unused variations.", - "required": false, - "type": "boolean" + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -19962,17 +23195,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -19981,19 +23223,16 @@ "type": "object" }, "download_expiry": { - "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { - "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { - "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" @@ -20003,17 +23242,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -20032,46 +23280,82 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -20083,10 +23367,12 @@ "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { - "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" @@ -20101,20 +23387,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -20158,9 +23461,13 @@ "type": "string" }, "status": { - "default": "publish", "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "enum": [ + "draft", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -20170,9 +23477,12 @@ "type": "integer" }, "stock_status": { - "default": "instock", "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -20182,21 +23492,24 @@ "type": "string" }, "tax_status": { - "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { - "default": "variation", "description": "Product type.", - "enum": ["variation"], + "enum": [ + "variation" + ], "required": false, "type": "string" }, "virtual": { - "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" @@ -20207,10 +23520,3534 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "POST", "POST", "POST"], + "methods": [ + "PATCH", + "PATCH", + "PATCH", + "PATCH", + "POST", + "POST", + "POST", + "POST", + "PUT", + "PUT", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/(?P[\\d]+)/variations/generate": { + "endpoints": [ + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "default_values": { + "description": "Default values for generated variations.", + "properties": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "description": { + "description": "Variation description.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "object", + "validate_callback": "rest_validate_request_arg" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "downloadable": { + "description": "If the variation is downloadable.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "object", + "validate_callback": "rest_validate_request_arg" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "integer", + "null" + ], + "validate_callback": "rest_validate_request_arg" + }, + "manage_stock": { + "description": "Stock management at variation level.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "name": { + "description": "Product parent name.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "parent_id": { + "description": "Product parent ID.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "regular_price": { + "description": "Variation regular price.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "sale_price": { + "description": "Variation sale price.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "shipping_class": { + "description": "Shipping class slug.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "sku": { + "description": "Stock Keeping Unit.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "status": { + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "stock_quantity": { + "description": "Stock quantity.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "tax_class": { + "description": "Tax class.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "type": { + "description": "Product type.", + "enum": [ + "variation" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "virtual": { + "description": "If the variation is virtual.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "weight": { + "description": "Variation weight (kg).", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + }, + "required": false, + "type": "object" + }, + "delete": { + "description": "Deletes unused variations.", + "required": false, + "type": "boolean" + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "default": false, + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "default": false, + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "default": "instock", + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "variation", + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "default": false, + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "default_values": { + "description": "Default values for generated variations.", + "properties": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "description": { + "description": "Variation description.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "object", + "validate_callback": "rest_validate_request_arg" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "downloadable": { + "description": "If the variation is downloadable.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "object", + "validate_callback": "rest_validate_request_arg" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "integer", + "null" + ], + "validate_callback": "rest_validate_request_arg" + }, + "manage_stock": { + "description": "Stock management at variation level.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "name": { + "description": "Product parent name.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "parent_id": { + "description": "Product parent ID.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "regular_price": { + "description": "Variation regular price.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "sale_price": { + "description": "Variation sale price.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "shipping_class": { + "description": "Shipping class slug.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "sku": { + "description": "Stock Keeping Unit.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "status": { + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "stock_quantity": { + "description": "Stock quantity.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "tax_class": { + "description": "Tax class.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "type": { + "description": "Product type.", + "enum": [ + "variation" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "virtual": { + "description": "If the variation is virtual.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "weight": { + "description": "Variation weight (kg).", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + }, + "required": false, + "type": "object" + }, + "delete": { + "description": "Deletes unused variations.", + "required": false, + "type": "boolean" + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "default": false, + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "default": false, + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "default": "instock", + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "variation", + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "default": false, + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "default_values": { + "description": "Default values for generated variations.", + "properties": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "description": { + "description": "Variation description.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "object", + "validate_callback": "rest_validate_request_arg" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "downloadable": { + "description": "If the variation is downloadable.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "object", + "validate_callback": "rest_validate_request_arg" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "integer", + "null" + ], + "validate_callback": "rest_validate_request_arg" + }, + "manage_stock": { + "description": "Stock management at variation level.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "name": { + "description": "Product parent name.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "parent_id": { + "description": "Product parent ID.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "regular_price": { + "description": "Variation regular price.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "sale_price": { + "description": "Variation sale price.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "shipping_class": { + "description": "Shipping class slug.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "sku": { + "description": "Stock Keeping Unit.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "status": { + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "stock_quantity": { + "description": "Stock quantity.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "tax_class": { + "description": "Tax class.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "type": { + "description": "Product type.", + "enum": [ + "variation" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "virtual": { + "description": "If the variation is virtual.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "weight": { + "description": "Variation weight (kg).", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + }, + "required": false, + "type": "object" + }, + "delete": { + "description": "Deletes unused variations.", + "required": false, + "type": "boolean" + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "default": false, + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "default": false, + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "default": "instock", + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "variation", + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "default": false, + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "backorders": { + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "required": false, + "type": "string" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "default_values": { + "description": "Default values for generated variations.", + "properties": { + "attributes": { + "description": "List of attributes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Attribute ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "option": { + "context": [ + "edit", + "view" + ], + "description": "Selected attribute term name.", + "type": "string" + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "null", + "string" + ], + "validate_callback": "rest_validate_request_arg" + }, + "description": { + "description": "Variation description.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "object", + "validate_callback": "rest_validate_request_arg" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "downloadable": { + "description": "If the variation is downloadable.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "object", + "validate_callback": "rest_validate_request_arg" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": [ + "integer", + "null" + ], + "validate_callback": "rest_validate_request_arg" + }, + "manage_stock": { + "description": "Stock management at variation level.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "sanitize_callback": "rest_sanitize_request_arg", + "type": "array", + "validate_callback": "rest_validate_request_arg" + }, + "name": { + "description": "Product parent name.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "parent_id": { + "description": "Product parent ID.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "regular_price": { + "description": "Variation regular price.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "sale_price": { + "description": "Variation sale price.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "shipping_class": { + "description": "Shipping class slug.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "sku": { + "description": "Stock Keeping Unit.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "status": { + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "stock_quantity": { + "description": "Stock quantity.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "integer", + "validate_callback": "rest_validate_request_arg" + }, + "stock_status": { + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "tax_class": { + "description": "Tax class.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "type": { + "description": "Product type.", + "enum": [ + "variation" + ], + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "virtual": { + "description": "If the variation is virtual.", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "boolean", + "validate_callback": "rest_validate_request_arg" + }, + "weight": { + "description": "Variation weight (kg).", + "sanitize_callback": "rest_sanitize_request_arg", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + }, + "required": false, + "type": "object" + }, + "delete": { + "description": "Deletes unused variations.", + "required": false, + "type": "boolean" + }, + "description": { + "description": "Variation description.", + "required": false, + "type": "string" + }, + "dimensions": { + "description": "Variation dimensions.", + "properties": { + "height": { + "context": [ + "edit", + "view" + ], + "description": "Variation height (cm).", + "type": "string" + }, + "length": { + "context": [ + "edit", + "view" + ], + "description": "Variation length (cm).", + "type": "string" + }, + "width": { + "context": [ + "edit", + "view" + ], + "description": "Variation width (cm).", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "download_expiry": { + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "required": false, + "type": "integer" + }, + "download_limit": { + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "required": false, + "type": "integer" + }, + "downloadable": { + "default": false, + "description": "If the variation is downloadable.", + "required": false, + "type": "boolean" + }, + "downloads": { + "description": "List of downloadable files.", + "items": { + "properties": { + "file": { + "context": [ + "edit", + "view" + ], + "description": "File URL.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "File ID.", + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "File name.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "image": { + "description": "Variation image data.", + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "required": false, + "type": [ + "integer", + "null" + ] + }, + "manage_stock": { + "default": false, + "description": "Stock management at variation level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "meta_data": { + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "name": { + "description": "Product parent name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "regular_price": { + "description": "Variation regular price.", + "required": false, + "type": "string" + }, + "sale_price": { + "description": "Variation sale price.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Shipping class slug.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Stock Keeping Unit.", + "required": false, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Variation status.", + "enum": [ + "draft", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "stock_status": { + "default": "instock", + "description": "Controls the stock status of the product.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "variation", + "description": "Product type.", + "enum": [ + "variation" + ], + "required": false, + "type": "string" + }, + "virtual": { + "default": false, + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST", + "POST", + "POST", + "POST" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes": { @@ -20227,7 +27064,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -20237,7 +27077,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -20255,7 +27097,12 @@ "order_by": { "default": "menu_order", "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -20267,19 +27114,26 @@ "type": { "default": "select", "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -20289,7 +27143,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -20307,7 +27163,12 @@ "order_by": { "default": "menu_order", "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -20319,18 +27180,27 @@ "type": { "default": "select", "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST", "GET", "POST"], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], "namespace": "wc-analytics" }, - "/wc-analytics/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { + "/wc-analytics/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { @@ -20342,7 +27212,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -20378,14 +27251,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -20426,7 +27310,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -20456,7 +27342,9 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { @@ -20468,7 +27356,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -20504,14 +27395,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -20552,7 +27454,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -20582,13 +27486,20 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST", "GET", "POST"], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], "namespace": "wc-analytics" }, - "/wc-analytics/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": { + "/wc-analytics/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { "endpoints": [ { "args": { @@ -20600,7 +27511,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -20610,7 +27524,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -20645,7 +27561,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -20666,7 +27586,9 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] }, { "args": { @@ -20678,7 +27600,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -20688,7 +27613,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -20723,7 +27650,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -20744,13 +27675,26 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "DELETE", + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, - "/wc-analytics/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": { + "/wc-analytics/products/attributes/(?P[\\d]+)/terms/batch": { "endpoints": [ { "args": { @@ -20780,7 +27724,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -20810,20 +27758,34 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, - "/wc-analytics/products/attributes/(?P\u003Cid\u003E[\\d]+)": { + "/wc-analytics/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -20833,7 +27795,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -20854,7 +27818,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -20865,12 +27834,18 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -20886,14 +27861,19 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -20903,7 +27883,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -20924,7 +27906,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -20935,12 +27922,18 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -20956,13 +27949,26 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "DELETE", + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, - "/wc-analytics/products/attributes/(?P\u003Cslug\u003E[a-z0-9_\\-]+)": { + "/wc-analytics/products/attributes/(?P[a-z0-9_\\-]+)": { "endpoints": [ { "args": { @@ -20972,7 +27978,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -20982,20 +27990,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, - "/wc-analytics/products/attributes/(?P\u003Cslug\u003E[a-z0-9_\\-]+)/terms": { + "/wc-analytics/products/attributes/(?P[a-z0-9_\\-]+)/terms": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -21031,14 +28047,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -21079,14 +28106,19 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -21122,14 +28154,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -21170,10 +28213,15 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes/batch": { @@ -21199,7 +28247,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -21210,12 +28263,18 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -21231,7 +28290,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -21242,15 +28306,28 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/batch": { @@ -21269,17 +28346,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -21287,18 +28373,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -21311,7 +28406,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -21322,7 +28421,12 @@ }, "catalog_visibility": { "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -21331,18 +28435,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -21364,49 +28477,76 @@ "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -21425,17 +28565,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -21463,17 +28612,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -21504,46 +28662,82 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -21557,7 +28751,10 @@ "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "description": "Stock management at product level.", @@ -21574,20 +28771,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -21657,7 +28871,15 @@ }, "status": { "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -21668,7 +28890,11 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -21677,18 +28903,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -21706,13 +28941,22 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -21735,7 +28979,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -21744,17 +28992,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -21762,18 +29019,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -21786,7 +29052,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -21797,7 +29067,12 @@ }, "catalog_visibility": { "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -21806,18 +29081,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -21839,49 +29123,76 @@ "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -21900,17 +29211,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -21938,17 +29258,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -21979,46 +29308,82 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -22032,7 +29397,10 @@ "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "description": "Stock management at product level.", @@ -22049,20 +29417,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -22132,7 +29517,15 @@ }, "status": { "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -22143,7 +29536,11 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -22152,18 +29549,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -22181,13 +29587,22 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -22210,10 +29625,21 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/categories": { @@ -22230,7 +29656,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -22266,14 +29695,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -22314,7 +29754,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -22326,7 +29768,12 @@ "display": { "default": "default", "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -22334,46 +29781,82 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -22403,14 +29886,19 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -22446,14 +29934,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -22494,7 +29993,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -22506,7 +30007,12 @@ "display": { "default": "default", "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -22514,46 +30020,82 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -22583,20 +30125,30 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST", "GET", "POST"], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], "namespace": "wc-analytics" }, - "/wc-analytics/products/categories/(?P\u003Cid\u003E[\\d]+)": { + "/wc-analytics/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -22606,7 +30158,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -22617,7 +30171,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -22630,46 +30189,82 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -22699,7 +30294,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -22715,14 +30314,19 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -22732,7 +30336,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -22743,7 +30349,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -22756,46 +30367,82 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -22825,7 +30472,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -22841,10 +30492,23 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "DELETE", + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/categories/batch": { @@ -22865,7 +30529,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -22873,46 +30542,82 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -22942,7 +30647,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -22953,7 +30662,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -22961,46 +30675,82 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -23030,10 +30780,21 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/count-low-in-stock": { @@ -23050,41 +30811,66 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/low-in-stock": { @@ -23101,7 +30887,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -23123,19 +30912,30 @@ "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -23157,15 +30957,26 @@ "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/reviews": { @@ -23194,7 +31005,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -23224,14 +31038,23 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date_gmt", "description": "Sort collection by object attribute.", - "enum": ["date", "date_gmt", "id", "include", "product"], + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ], "required": false, "type": "string" }, @@ -23290,12 +31113,20 @@ "status": { "default": "approved", "description": "Limit result set to reviews assigned a specific status.", - "enum": ["all", "hold", "approved", "spam", "trash"], + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -23332,12 +31163,21 @@ "status": { "default": "approved", "description": "Status of the review.", - "enum": ["approved", "hold", "spam", "unspam", "trash", "untrash"], + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { @@ -23356,7 +31196,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -23386,14 +31229,23 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date_gmt", "description": "Sort collection by object attribute.", - "enum": ["date", "date_gmt", "id", "include", "product"], + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ], "required": false, "type": "string" }, @@ -23452,12 +31304,20 @@ "status": { "default": "approved", "description": "Limit result set to reviews assigned a specific status.", - "enum": ["all", "hold", "approved", "spam", "trash"], + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -23494,25 +31354,42 @@ "status": { "default": "approved", "description": "Status of the review.", - "enum": ["approved", "hold", "spam", "unspam", "trash", "untrash"], + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST", "GET", "POST"], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], "namespace": "wc-analytics" }, - "/wc-analytics/products/reviews/(?P\u003Cid\u003E[\\d]+)": { + "/wc-analytics/products/reviews/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -23522,7 +31399,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -23564,12 +31443,23 @@ }, "status": { "description": "Status of the review.", - "enum": ["approved", "hold", "spam", "unspam", "trash", "untrash"], + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -23585,14 +31475,19 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -23602,7 +31497,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -23644,12 +31541,23 @@ }, "status": { "description": "Status of the review.", - "enum": ["approved", "hold", "spam", "unspam", "trash", "untrash"], + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -23665,10 +31573,23 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "DELETE", + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/reviews/batch": { @@ -23715,12 +31636,23 @@ }, "status": { "description": "Status of the review.", - "enum": ["approved", "hold", "spam", "unspam", "trash", "untrash"], + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -23757,15 +31689,33 @@ }, "status": { "description": "Status of the review.", - "enum": ["approved", "hold", "spam", "unspam", "trash", "untrash"], + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/products/suggested-products": { @@ -23818,7 +31768,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -23915,7 +31869,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -23926,14 +31883,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -23994,7 +31951,15 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -24014,12 +31979,19 @@ }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -24062,7 +32034,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -24159,7 +32135,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -24170,14 +32149,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -24238,7 +32217,15 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -24258,15 +32245,25 @@ }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports": { @@ -24283,18 +32280,24 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, - "/wc-analytics/reports/(?P\u003Ctype\u003E[a-z]+)/export": { + "/wc-analytics/reports/(?P[a-z]+)/export": { "endpoints": [ { "args": { @@ -24309,20 +32312,32 @@ "type": "object" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-analytics" }, - "/wc-analytics/reports/(?P\u003Ctype\u003E[a-z]+)/export/(?P\u003Cexport_id\u003E[a-z0-9]+)/status": { + "/wc-analytics/reports/(?P[a-z]+)/export/(?P[a-z0-9]+)/status": { "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/categories": { @@ -24359,7 +32374,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -24377,21 +32395,38 @@ "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", - "enum": ["hour", "day", "week", "month", "quarter", "year"], + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "category_id", "description": "Sort collection by object attribute.", - "enum": ["category_id", "items_sold", "net_revenue", "orders_count", "products_count", "category"], + "enum": [ + "category", + "category_id", + "items_sold", + "net_revenue", + "orders_count", + "products_count" + ], "required": false, "type": "string" }, @@ -24415,15 +32450,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" }, @@ -24435,15 +32470,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" }, @@ -24451,10 +32486,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/coupons": { @@ -24483,7 +32522,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -24509,14 +32551,22 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "coupon_id", "description": "Sort collection by object attribute.", - "enum": ["coupon_id", "code", "amount", "orders_count"], + "enum": [ + "amount", + "code", + "coupon_id", + "orders_count" + ], "required": false, "type": "string" }, @@ -24536,10 +32586,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/coupons/stats": { @@ -24568,7 +32622,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -24596,21 +32653,36 @@ "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", - "enum": ["hour", "day", "week", "month", "quarter", "year"], + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "amount", "coupons_count", "orders_count"], + "enum": [ + "amount", + "coupons_count", + "date", + "orders_count" + ], "required": false, "type": "string" }, @@ -24631,15 +32703,24 @@ }, "segmentby": { "description": "Segment the response by additional constraint.", - "enum": ["product", "variation", "category", "coupon"], + "enum": [ + "category", + "coupon", + "product", + "variation" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/customers": { @@ -24686,7 +32767,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -24721,7 +32805,14 @@ "filter_empty": { "description": "Filter out results where any of the passed fields are empty", "items": { - "enum": ["email", "name", "country", "city", "state", "postcode"], + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], "type": "string" }, "required": false, @@ -24767,7 +32858,10 @@ "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, @@ -24784,7 +32878,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -24792,17 +32889,17 @@ "default": "date_registered", "description": "Sort collection by object attribute.", "enum": [ - "username", - "name", - "country", + "avg_order_value", "city", - "state", - "postcode", - "date_registered", + "country", "date_last_active", + "date_registered", + "name", "orders_count", + "postcode", + "state", "total_spend", - "avg_order_value" + "username" ], "required": false, "type": "string" @@ -24868,7 +32965,12 @@ "searchby": { "default": "name", "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "enum": ["name", "username", "email", "all"], + "enum": [ + "all", + "email", + "name", + "username" + ], "required": false, "type": "string" }, @@ -24909,10 +33011,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/customers/stats": { @@ -24947,7 +33053,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -25027,7 +33136,10 @@ "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, @@ -25087,7 +33199,12 @@ "searchby": { "default": "name", "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "enum": ["name", "username", "email", "all"], + "enum": [ + "all", + "email", + "name", + "username" + ], "required": false, "type": "string" }, @@ -25120,10 +33237,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/downloads": { @@ -25152,7 +33273,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -25196,14 +33320,20 @@ "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: products, orders, username, ip_address.", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -25226,7 +33356,10 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "product"], + "enum": [ + "date", + "product" + ], "required": false, "type": "string" }, @@ -25264,10 +33397,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/downloads/stats": { @@ -25296,7 +33433,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -25332,7 +33472,14 @@ "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", - "enum": ["hour", "day", "week", "month", "quarter", "year"], + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], "required": false, "type": "string" }, @@ -25355,14 +33502,20 @@ "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -25385,7 +33538,10 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "download_count"], + "enum": [ + "date", + "download_count" + ], "required": false, "type": "string" }, @@ -25423,10 +33579,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import": { @@ -25453,10 +33613,18 @@ "type": "boolean" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import/cancel": { @@ -25470,10 +33638,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import/delete": { @@ -25487,10 +33663,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import/status": { @@ -25504,10 +33688,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import/totals": { @@ -25534,10 +33722,14 @@ "type": "boolean" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/orders": { @@ -25584,7 +33776,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -25609,7 +33804,11 @@ "customer_type": { "default": "", "description": "Limit result set to returning or new customers.", - "enum": ["", "returning", "new"], + "enum": [ + "", + "new", + "returning" + ], "required": false, "type": "string" }, @@ -25627,7 +33826,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -25650,7 +33852,11 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "num_items_sold", "net_total"], + "enum": [ + "date", + "net_total", + "num_items_sold" + ], "required": false, "type": "string" }, @@ -25690,7 +33896,13 @@ "refunds": { "default": "", "description": "Limit result set to specific types of refunds.", - "enum": ["", "all", "partial", "full", "none"], + "enum": [ + "", + "all", + "full", + "none", + "partial" + ], "required": false, "type": "string" }, @@ -25699,15 +33911,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" }, @@ -25719,15 +33931,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" }, @@ -25771,10 +33983,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/orders/stats": { @@ -25821,7 +34037,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -25845,13 +34064,19 @@ }, "customer": { "description": "Alias for customer_type (deprecated).", - "enum": ["new", "returning"], + "enum": [ + "new", + "returning" + ], "required": false, "type": "string" }, "customer_type": { "description": "Limit result set to orders that have the specified customer_type", - "enum": ["new", "returning"], + "enum": [ + "new", + "returning" + ], "required": false, "type": "string" }, @@ -25871,28 +34096,46 @@ "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", - "enum": ["hour", "day", "week", "month", "quarter", "year"], + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], "required": false, "type": "string" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "net_revenue", "orders_count", "avg_order_value"], + "enum": [ + "avg_order_value", + "date", + "net_revenue", + "orders_count" + ], "required": false, "type": "string" }, @@ -25932,13 +34175,25 @@ "refunds": { "default": "", "description": "Limit result set to specific types of refunds.", - "enum": ["", "all", "partial", "full", "none"], + "enum": [ + "", + "all", + "full", + "none", + "partial" + ], "required": false, "type": "string" }, "segmentby": { "description": "Segment the response by additional constraint.", - "enum": ["product", "category", "variation", "coupon", "customer_type"], + "enum": [ + "category", + "coupon", + "customer_type", + "product", + "variation" + ], "required": false, "type": "string" }, @@ -25948,15 +34203,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" }, @@ -25968,15 +34223,15 @@ "items": { "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" }, @@ -26020,10 +34275,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/performance-indicators": { @@ -26052,46 +34311,49 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "stats": { "default": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.", "items": { "enum": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "type": "string" }, @@ -26099,10 +34361,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/performance-indicators/allowed": { @@ -26131,46 +34397,49 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "stats": { "default": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.", "items": { "enum": [ - "revenue/total_sales", - "revenue/net_revenue", - "revenue/shipping", - "revenue/refunds", - "revenue/gross_sales", - "orders/orders_count", - "orders/avg_order_value", - "products/items_sold", - "variations/items_sold", "coupons/amount", "coupons/orders_count", - "taxes/total_tax", + "downloads/download_count", + "orders/avg_order_value", + "orders/orders_count", + "products/items_sold", + "revenue/gross_sales", + "revenue/net_revenue", + "revenue/refunds", + "revenue/shipping", + "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", - "downloads/download_count" + "taxes/total_tax", + "variations/items_sold" ], "type": "string" }, @@ -26178,10 +34447,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/products": { @@ -26218,7 +34491,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -26236,21 +34512,35 @@ "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "net_revenue", "orders_count", "items_sold", "product_name", "variations", "sku"], + "enum": [ + "date", + "items_sold", + "net_revenue", + "orders_count", + "product_name", + "sku", + "variations" + ], "required": false, "type": "string" }, @@ -26278,10 +34568,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/products/stats": { @@ -26318,7 +34612,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -26338,14 +34635,24 @@ "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", - "enum": ["hour", "day", "week", "month", "quarter", "year"], + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -26353,15 +34660,15 @@ "default": "date", "description": "Sort collection by object attribute.", "enum": [ - "date", - "net_revenue", "coupons", - "refunds", - "shipping", - "taxes", + "date", + "items_sold", + "net_revenue", "net_revenue", "orders_count", - "items_sold" + "refunds", + "shipping", + "taxes" ], "required": false, "type": "string" @@ -26391,7 +34698,11 @@ }, "segmentby": { "description": "Segment the response by additional constraint.", - "enum": ["product", "category", "variation"], + "enum": [ + "category", + "product", + "variation" + ], "required": false, "type": "string" }, @@ -26404,10 +34715,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/revenue/stats": { @@ -26436,13 +34751,20 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "date_type": { "description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.", - "enum": ["date_paid", "date_created", "date_completed"], + "enum": [ + "date_completed", + "date_created", + "date_paid" + ], "required": false, "type": "string" }, @@ -26454,14 +34776,24 @@ "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", - "enum": ["hour", "day", "week", "month", "quarter", "year"], + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -26469,16 +34801,16 @@ "default": "date", "description": "Sort collection by object attribute.", "enum": [ - "date", - "total_sales", "coupons", + "date", + "gross_sales", + "items_sold", + "net_revenue", + "orders_count", "refunds", "shipping", "taxes", - "net_revenue", - "orders_count", - "items_sold", - "gross_sales" + "total_sales" ], "required": false, "type": "string" @@ -26500,15 +34832,25 @@ }, "segmentby": { "description": "Segment the response by additional constraint.", - "enum": ["product", "category", "variation", "coupon", "customer_type"], + "enum": [ + "category", + "coupon", + "customer_type", + "product", + "variation" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/stock": { @@ -26525,7 +34867,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -26555,14 +34900,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "stock_status", "description": "Sort collection by object attribute.", - "enum": ["stock_status", "stock_quantity", "date", "id", "include", "title", "sku"], + "enum": [ + "date", + "id", + "include", + "sku", + "stock_quantity", + "stock_status", + "title" + ], "required": false, "type": "string" }, @@ -26602,15 +34958,25 @@ "type": { "default": "all", "description": "Limit result set to items assigned a stock report type.", - "enum": ["all", "lowstock", "instock", "outofstock", "onbackorder"], + "enum": [ + "all", + "instock", + "lowstock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/stock/stats": { @@ -26627,15 +34993,22 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/taxes": { @@ -26664,7 +35037,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -26676,7 +35052,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -26685,13 +35064,13 @@ "description": "Sort collection by object attribute.", "enum": [ "name", - "tax_rate_id", - "tax_code", - "rate", "order_tax", - "total_tax", + "orders_count", + "rate", "shipping_tax", - "orders_count" + "tax_code", + "tax_rate_id", + "total_tax" ], "required": false, "type": "string" @@ -26720,10 +35099,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/taxes/stats": { @@ -26752,7 +35135,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -26772,21 +35158,37 @@ "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", - "enum": ["hour", "day", "week", "month", "quarter", "year"], + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "items_sold", "total_sales", "orders_count", "products_count"], + "enum": [ + "date", + "items_sold", + "orders_count", + "products_count", + "total_sales" + ], "required": false, "type": "string" }, @@ -26807,7 +35209,9 @@ }, "segmentby": { "description": "Segment the response by additional constraint.", - "enum": ["tax_rate_id"], + "enum": [ + "tax_rate_id" + ], "required": false, "type": "string" }, @@ -26820,10 +35224,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/variations": { @@ -26886,7 +35294,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -26904,21 +35315,33 @@ "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "net_revenue", "orders_count", "items_sold", "sku"], + "enum": [ + "date", + "items_sold", + "net_revenue", + "orders_count", + "sku" + ], "required": false, "type": "string" }, @@ -26972,10 +35395,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, "/wc-analytics/reports/variations/stats": { @@ -27038,7 +35465,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -27058,21 +35488,34 @@ "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", - "enum": ["hour", "day", "week", "month", "quarter", "year"], + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], "required": false, "type": "string" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", - "enum": ["all", "any"], + "enum": [ + "all", + "any" + ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -27080,15 +35523,15 @@ "default": "date", "description": "Sort collection by object attribute.", "enum": [ - "date", - "net_revenue", "coupons", - "refunds", - "shipping", - "taxes", + "date", + "items_sold", + "net_revenue", "net_revenue", "orders_count", - "items_sold" + "refunds", + "shipping", + "taxes" ], "required": false, "type": "string" @@ -27128,7 +35571,11 @@ }, "segmentby": { "description": "Segment the response by additional constraint.", - "enum": ["product", "category", "variation"], + "enum": [ + "category", + "product", + "variation" + ], "required": false, "type": "string" }, @@ -27141,13 +35588,17 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-analytics" }, - "/wc-analytics/settings/(?P\u003Cgroup_id\u003E[\\w-]+)": { + "/wc-analytics/settings/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -27157,7 +35608,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -27167,13 +35620,18 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET"], + "methods": [ + "GET", + "GET" + ], "namespace": "wc-analytics" }, - "/wc-analytics/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/(?P\u003Cid\u003E[\\w-]+)": { + "/wc-analytics/settings/(?P[\\w-]+)/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -27188,7 +35646,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -27205,10 +35665,22 @@ "value": { "description": "Setting value.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -27223,7 +35695,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -27240,16 +35714,37 @@ "value": { "description": "Setting value.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, - "/wc-analytics/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/batch": { + "/wc-analytics/settings/(?P[\\w-]+)/batch": { "endpoints": [ { "args": { @@ -27261,10 +35756,22 @@ "value": { "description": "Setting value.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -27276,13 +35783,32 @@ "value": { "description": "Setting value.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/taxes": { @@ -27298,14 +35824,21 @@ "args": { "class": { "description": "Sort by tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -27326,14 +35859,21 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", - "enum": ["id", "order", "priority"], + "enum": [ + "id", + "order", + "priority" + ], "required": false, "type": "string" }, @@ -27358,7 +35898,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -27378,7 +35920,11 @@ "class": { "default": "standard", "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -27439,20 +35985,29 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { "class": { "description": "Sort by tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -27473,14 +36028,21 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", - "enum": ["id", "order", "priority"], + "enum": [ + "id", + "order", + "priority" + ], "required": false, "type": "string" }, @@ -27505,7 +36067,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -27525,7 +36089,11 @@ "class": { "default": "standard", "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -27586,20 +36154,30 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST", "GET", "POST"], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], "namespace": "wc-analytics" }, - "/wc-analytics/taxes/(?P\u003Cid\u003E[\\d]+)": { + "/wc-analytics/taxes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -27609,7 +36187,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -27628,7 +36208,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -27691,7 +36275,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -27707,14 +36295,19 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -27724,7 +36317,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -27743,7 +36338,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -27806,7 +36405,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -27822,10 +36425,23 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "DELETE", + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/taxes/batch": { @@ -27854,7 +36470,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -27912,7 +36532,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -27931,7 +36555,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -27989,10 +36617,21 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH", "POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], "namespace": "wc-analytics" }, "/wc-analytics/variations": { @@ -28043,7 +36682,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -28129,14 +36771,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -28191,18 +36844,32 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -28243,7 +36910,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -28329,14 +36999,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -28391,18 +37072,32 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -28443,7 +37138,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -28529,14 +37227,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -28591,18 +37300,32 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -28643,7 +37366,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -28729,14 +37455,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -28791,21 +37528,40 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET", "GET", "GET", "GET"], + "methods": [ + "GET", + "GET", + "GET", + "GET" + ], "namespace": "wc-analytics" }, "/wc-telemetry": { @@ -28828,10 +37584,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc-telemetry" }, "/wc-telemetry/tracker": { @@ -28862,10 +37622,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc-telemetry" }, "/wc/private": { @@ -28888,10 +37652,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/private" }, "/wc/private/ai/business-description": { @@ -28914,10 +37682,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/private" }, "/wc/private/ai/images": { @@ -28940,10 +37712,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/private" }, "/wc/private/ai/patterns": { @@ -28971,17 +37747,24 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "allow_batch": { "v1": true }, "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["POST", "DELETE"], + "methods": [ + "DELETE", + "POST" + ], "namespace": "wc/private" }, "/wc/private/ai/product": { @@ -29009,10 +37792,14 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/private" }, "/wc/private/ai/products": { @@ -29040,17 +37827,24 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "allow_batch": { "v1": true }, "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["POST", "DELETE"], + "methods": [ + "DELETE", + "POST" + ], "namespace": "wc/private" }, "/wc/private/ai/store-info": { @@ -29067,10 +37861,14 @@ "v1": true }, "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/private" }, "/wc/private/ai/store-title": { @@ -29093,10 +37891,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/private" }, "/wc/private/patterns": { @@ -29110,14 +37912,21 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/private" }, "/wc/store": { @@ -29140,10 +37949,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, "/wc/store/batch": { @@ -29170,14 +37983,22 @@ "items": { "type": "string" }, - "type": ["string", "array"] + "type": [ + "array", + "string" + ] }, "properties": [], "type": "object" }, "method": { "default": "POST", - "enum": ["POST", "PUT", "PATCH", "DELETE"], + "enum": [ + "DELETE", + "PATCH", + "POST", + "PUT" + ], "type": "string" }, "path": { @@ -29193,15 +38014,22 @@ }, "validation": { "default": "normal", - "enum": ["require-all-validate", "normal"], + "enum": [ + "normal", + "require-all-validate" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, "/wc/store/cart": { @@ -29218,15 +38046,22 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, "/wc/store/cart/add-item": { @@ -29258,12 +38093,18 @@ "items": { "properties": { "attribute": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute name.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute value.", "type": "string" } @@ -29274,10 +38115,14 @@ "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, "/wc/store/cart/apply-coupon": { @@ -29300,10 +38145,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, "/wc/store/cart/coupons": { @@ -29323,12 +38172,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -29346,20 +38200,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "allow_batch": { "v1": true }, "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "DELETE"], + "methods": [ + "DELETE", + "GET", + "POST" + ], "namespace": "wc/store" }, - "/wc/store/cart/coupons/(?P\u003Ccode\u003E[\\w-]+)": { + "/wc/store/cart/coupons/(?P[\\w-]+)": { "endpoints": [ { "allow_batch": { @@ -29374,12 +38236,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -29392,10 +38259,15 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/store" }, "/wc/store/cart/extensions": { @@ -29423,10 +38295,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, "/wc/store/cart/items": { @@ -29446,12 +38322,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -29465,20 +38346,28 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "allow_batch": { "v1": true }, "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "DELETE"], + "methods": [ + "DELETE", + "GET", + "POST" + ], "namespace": "wc/store" }, - "/wc/store/cart/items/(?P\u003Ckey\u003E[\\w-]{32})": { + "/wc/store/cart/items/(?P[\\w-]{32})": { "endpoints": [ { "allow_batch": { @@ -29488,7 +38377,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -29498,7 +38390,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -29516,7 +38410,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -29529,10 +38427,18 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/store" }, "/wc/store/cart/remove-coupon": { @@ -29555,10 +38461,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, "/wc/store/cart/remove-item": { @@ -29581,10 +38491,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, "/wc/store/cart/select-shipping-rate": { @@ -29604,7 +38518,11 @@ "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "required": false, - "type": ["integer", "string", "null"] + "type": [ + "integer", + "null", + "string" + ] }, "rate_id": { "description": "The chosen rate ID for the package.", @@ -29612,10 +38530,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, "/wc/store/cart/update-customer": { @@ -29636,67 +38558,100 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -29709,61 +38664,91 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -29773,10 +38758,14 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, "/wc/store/cart/update-item": { @@ -29804,10 +38793,14 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, "/wc/store/checkout": { @@ -29827,12 +38820,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -29849,67 +38847,100 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -29939,91 +38970,145 @@ }, "properties": { "woocommerce/order-attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] } }, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] } }, "required": false, @@ -30037,7 +39122,10 @@ "type": "string" }, "value": { - "type": ["string", "boolean"] + "type": [ + "boolean", + "string" + ] } }, "type": "object" @@ -30047,7 +39135,11 @@ }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", - "enum": ["bacs", "cheque", "cod"], + "enum": [ + "bacs", + "cheque", + "cod" + ], "required": false, "type": "string" }, @@ -30055,61 +39147,91 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -30119,13 +39241,18 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/store" }, - "/wc/store/checkout/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/checkout/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -30142,67 +39269,100 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -30222,91 +39382,145 @@ }, "properties": { "woocommerce/order-attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] } }, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] } }, "required": false, @@ -30320,7 +39534,10 @@ "type": "string" }, "value": { - "type": ["string", "boolean"] + "type": [ + "boolean", + "string" + ] } }, "type": "object" @@ -30330,7 +39547,11 @@ }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", - "enum": ["bacs", "cheque", "cod"], + "enum": [ + "bacs", + "cheque", + "cod" + ], "required": false, "type": "string" }, @@ -30338,61 +39559,91 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -30402,28 +39653,39 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store" }, - "/wc/store/order/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/order/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, "/wc/store/products": { @@ -30446,7 +39708,10 @@ "attribute_relation": { "default": "and", "description": "The logical relationship between attributes when filtering across several at once.", - "enum": ["in", "and"], + "enum": [ + "and", + "in" + ], "required": false, "type": "string" }, @@ -30462,7 +39727,11 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { @@ -30495,7 +39764,13 @@ }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", - "enum": ["any", "visible", "catalog", "search", "hidden"], + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -30507,21 +39782,33 @@ "category_operator": { "default": "in", "description": "Operator to compare product category terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "date_column": { "default": "date", "description": "When limiting response using after/before, which date column to compare against.", - "enum": ["date", "date_gmt", "modified", "modified_gmt"], + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ], "required": false, "type": "string" }, @@ -30571,7 +39858,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -30579,17 +39869,17 @@ "default": "date", "description": "Sort collection by object attribute.", "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -30631,7 +39921,13 @@ "default": [], "description": "Limit result set to products with a certain average rating.", "items": { - "enum": [1, 2, 3, 4, 5], + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], "type": "integer" }, "required": false, @@ -30656,7 +39952,11 @@ "default": [], "description": "Limit result set to products with specified stock status.", "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -30672,31 +39972,48 @@ "tag_operator": { "default": "in", "description": "Operator to compare product tags.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable", "variation"], + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, - "/wc/store/products/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -30706,20 +40023,27 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, - "/wc/store/products/(?P\u003Cslug\u003E[\\S]+)": { + "/wc/store/products/(?P[\\S]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -30729,10 +40053,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, "/wc/store/products/attributes": { @@ -30748,18 +40076,25 @@ "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, - "/wc/store/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { + "/wc/store/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { @@ -30771,7 +40106,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -30802,14 +40140,24 @@ "order": { "default": "asc", "description": "Sort ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", - "enum": ["name", "slug", "count", "menu_order", "name_num", "id"], + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ], "required": false, "type": "string" }, @@ -30833,20 +40181,27 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, - "/wc/store/products/attributes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -30856,10 +40211,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, "/wc/store/products/categories": { @@ -30876,7 +40235,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -30907,14 +40270,21 @@ "order": { "default": "asc", "description": "Sort ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", - "enum": ["name", "slug", "count"], + "enum": [ + "count", + "name", + "slug" + ], "required": false, "type": "string" }, @@ -30938,20 +40308,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, - "/wc/store/products/categories/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -30961,10 +40339,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, "/wc/store/products/collection-data": { @@ -30987,7 +40369,10 @@ "attribute_relation": { "default": "and", "description": "The logical relationship between attributes when filtering across several at once.", - "enum": ["in", "and"], + "enum": [ + "and", + "in" + ], "required": false, "type": "string" }, @@ -31003,7 +40388,11 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { @@ -31040,14 +40429,23 @@ "items": { "properties": { "query_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "enum": ["and", "or"], + "enum": [ + "and", + "or" + ], "readonly": true, "type": "string" }, "taxonomy": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxonomy name.", "readonly": true, "type": "string" @@ -31078,7 +40476,13 @@ }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", - "enum": ["any", "visible", "catalog", "search", "hidden"], + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -31090,21 +40494,33 @@ "category_operator": { "default": "in", "description": "Operator to compare product category terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "date_column": { "default": "date", "description": "When limiting response using after/before, which date column to compare against.", - "enum": ["date", "date_gmt", "modified", "modified_gmt"], + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ], "required": false, "type": "string" }, @@ -31154,7 +40570,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -31162,17 +40581,17 @@ "default": "date", "description": "Sort collection by object attribute.", "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -31214,7 +40633,13 @@ "default": [], "description": "Limit result set to products with a certain average rating.", "items": { - "enum": [1, 2, 3, 4, 5], + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], "type": "integer" }, "required": false, @@ -31239,7 +40664,11 @@ "default": [], "description": "Limit result set to products with specified stock status.", "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -31255,21 +40684,35 @@ "tag_operator": { "default": "in", "description": "Operator to compare product tags.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable", "variation"], + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, "/wc/store/products/reviews": { @@ -31291,7 +40734,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -31303,14 +40749,23 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "date_gmt", "id", "rating", "product"], + "enum": [ + "date", + "date_gmt", + "id", + "product", + "rating" + ], "required": false, "type": "string" }, @@ -31335,10 +40790,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, "/wc/store/products/tags": { @@ -31355,7 +40814,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -31386,14 +40848,21 @@ "order": { "default": "asc", "description": "Sort ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", - "enum": ["name", "slug", "count"], + "enum": [ + "count", + "name", + "slug" + ], "required": false, "type": "string" }, @@ -31417,10 +40886,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store" }, "/wc/store/v1": { @@ -31443,10 +40916,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/batch": { @@ -31473,14 +40950,22 @@ "items": { "type": "string" }, - "type": ["string", "array"] + "type": [ + "array", + "string" + ] }, "properties": [], "type": "object" }, "method": { "default": "POST", - "enum": ["POST", "PUT", "PATCH", "DELETE"], + "enum": [ + "DELETE", + "PATCH", + "POST", + "PUT" + ], "type": "string" }, "path": { @@ -31496,15 +40981,22 @@ }, "validation": { "default": "normal", - "enum": ["require-all-validate", "normal"], + "enum": [ + "normal", + "require-all-validate" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart": { @@ -31521,15 +41013,22 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/add-item": { @@ -31561,12 +41060,18 @@ "items": { "properties": { "attribute": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute name.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation attribute value.", "type": "string" } @@ -31577,10 +41082,14 @@ "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/apply-coupon": { @@ -31603,10 +41112,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/coupons": { @@ -31626,12 +41139,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -31649,20 +41167,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "allow_batch": { "v1": true }, "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "DELETE"], + "methods": [ + "DELETE", + "GET", + "POST" + ], "namespace": "wc/store/v1" }, - "/wc/store/v1/cart/coupons/(?P\u003Ccode\u003E[\\w-]+)": { + "/wc/store/v1/cart/coupons/(?P[\\w-]+)": { "endpoints": [ { "allow_batch": { @@ -31677,12 +41203,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -31695,10 +41226,15 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/extensions": { @@ -31726,10 +41262,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/items": { @@ -31749,12 +41289,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -31768,20 +41313,28 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "allow_batch": { "v1": true }, "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "DELETE"], + "methods": [ + "DELETE", + "GET", + "POST" + ], "namespace": "wc/store/v1" }, - "/wc/store/v1/cart/items/(?P\u003Ckey\u003E[\\w-]{32})": { + "/wc/store/v1/cart/items/(?P[\\w-]{32})": { "endpoints": [ { "allow_batch": { @@ -31791,7 +41344,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -31801,7 +41357,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -31819,7 +41377,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -31832,10 +41394,18 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/remove-coupon": { @@ -31858,10 +41428,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/remove-item": { @@ -31884,10 +41458,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/select-shipping-rate": { @@ -31907,7 +41485,11 @@ "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "required": false, - "type": ["integer", "string", "null"] + "type": [ + "integer", + "null", + "string" + ] }, "rate_id": { "description": "The chosen rate ID for the package.", @@ -31915,10 +41497,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/update-customer": { @@ -31939,67 +41525,100 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -32012,61 +41631,91 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -32076,10 +41725,14 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/update-item": { @@ -32107,10 +41760,14 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/checkout": { @@ -32130,12 +41787,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -32152,67 +41814,100 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -32242,91 +41937,145 @@ }, "properties": { "woocommerce/order-attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] } }, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] } }, "required": false, @@ -32340,7 +42089,10 @@ "type": "string" }, "value": { - "type": ["string", "boolean"] + "type": [ + "boolean", + "string" + ] } }, "type": "object" @@ -32350,7 +42102,11 @@ }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", - "enum": ["bacs", "cheque", "cod"], + "enum": [ + "bacs", + "cheque", + "cod" + ], "required": false, "type": "string" }, @@ -32358,61 +42114,91 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -32422,13 +42208,18 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/store/v1" }, - "/wc/store/v1/checkout/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/v1/checkout/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -32445,67 +42236,100 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -32525,91 +42349,145 @@ }, "properties": { "woocommerce/order-attribution": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] } }, - "type": ["object", "null"] + "type": [ + "null", + "object" + ] } }, "required": false, @@ -32623,7 +42501,10 @@ "type": "string" }, "value": { - "type": ["string", "boolean"] + "type": [ + "boolean", + "string" + ] } }, "type": "object" @@ -32633,7 +42514,11 @@ }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", - "enum": ["bacs", "cheque", "cod"], + "enum": [ + "bacs", + "cheque", + "cod" + ], "required": false, "type": "string" }, @@ -32641,61 +42526,91 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address", "required": true, "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City", "required": true, "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company", "required": true, "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name", "required": true, "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name", "required": true, "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone", "required": true, "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postcode", "required": true, "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" @@ -32705,28 +42620,39 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/store/v1" }, - "/wc/store/v1/order/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/v1/order/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/products": { @@ -32749,7 +42675,10 @@ "attribute_relation": { "default": "and", "description": "The logical relationship between attributes when filtering across several at once.", - "enum": ["in", "and"], + "enum": [ + "and", + "in" + ], "required": false, "type": "string" }, @@ -32765,7 +42694,11 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { @@ -32798,7 +42731,13 @@ }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", - "enum": ["any", "visible", "catalog", "search", "hidden"], + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -32810,21 +42749,33 @@ "category_operator": { "default": "in", "description": "Operator to compare product category terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "date_column": { "default": "date", "description": "When limiting response using after/before, which date column to compare against.", - "enum": ["date", "date_gmt", "modified", "modified_gmt"], + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ], "required": false, "type": "string" }, @@ -32874,7 +42825,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -32882,17 +42836,17 @@ "default": "date", "description": "Sort collection by object attribute.", "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -32934,7 +42888,13 @@ "default": [], "description": "Limit result set to products with a certain average rating.", "items": { - "enum": [1, 2, 3, 4, 5], + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], "type": "integer" }, "required": false, @@ -32959,7 +42919,11 @@ "default": [], "description": "Limit result set to products with specified stock status.", "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -32975,31 +42939,48 @@ "tag_operator": { "default": "in", "description": "Operator to compare product tags.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable", "variation"], + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, - "/wc/store/v1/products/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/v1/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -33009,20 +42990,27 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, - "/wc/store/v1/products/(?P\u003Cslug\u003E[\\S]+)": { + "/wc/store/v1/products/(?P[\\S]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -33032,10 +43020,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/attributes": { @@ -33051,18 +43043,25 @@ "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, - "/wc/store/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { + "/wc/store/v1/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { @@ -33074,7 +43073,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -33105,14 +43107,24 @@ "order": { "default": "asc", "description": "Sort ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", - "enum": ["name", "slug", "count", "menu_order", "name_num", "id"], + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ], "required": false, "type": "string" }, @@ -33136,20 +43148,27 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, - "/wc/store/v1/products/attributes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/v1/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -33159,10 +43178,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/categories": { @@ -33179,7 +43202,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -33210,14 +43237,21 @@ "order": { "default": "asc", "description": "Sort ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", - "enum": ["name", "slug", "count"], + "enum": [ + "count", + "name", + "slug" + ], "required": false, "type": "string" }, @@ -33241,20 +43275,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, - "/wc/store/v1/products/categories/(?P\u003Cid\u003E[\\d]+)": { + "/wc/store/v1/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -33264,10 +43306,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/collection-data": { @@ -33290,7 +43336,10 @@ "attribute_relation": { "default": "and", "description": "The logical relationship between attributes when filtering across several at once.", - "enum": ["in", "and"], + "enum": [ + "and", + "in" + ], "required": false, "type": "string" }, @@ -33306,7 +43355,11 @@ }, "operator": { "description": "Operator to compare product attribute terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "type": "string" }, "slug": { @@ -33343,14 +43396,23 @@ "items": { "properties": { "query_type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "enum": ["and", "or"], + "enum": [ + "and", + "or" + ], "readonly": true, "type": "string" }, "taxonomy": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Taxonomy name.", "readonly": true, "type": "string" @@ -33381,7 +43443,13 @@ }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", - "enum": ["any", "visible", "catalog", "search", "hidden"], + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -33393,21 +43461,33 @@ "category_operator": { "default": "in", "description": "Operator to compare product category terms.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, "date_column": { "default": "date", "description": "When limiting response using after/before, which date column to compare against.", - "enum": ["date", "date_gmt", "modified", "modified_gmt"], + "enum": [ + "date", + "date_gmt", + "modified", + "modified_gmt" + ], "required": false, "type": "string" }, @@ -33457,7 +43537,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -33465,17 +43548,17 @@ "default": "date", "description": "Sort collection by object attribute.", "enum": [ + "comment_count", "date", - "modified", "id", "include", - "title", - "slug", - "price", - "popularity", - "rating", "menu_order", - "comment_count" + "modified", + "popularity", + "price", + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -33517,7 +43600,13 @@ "default": [], "description": "Limit result set to products with a certain average rating.", "items": { - "enum": [1, 2, 3, 4, 5], + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], "type": "integer" }, "required": false, @@ -33542,7 +43631,11 @@ "default": [], "description": "Limit result set to products with specified stock status.", "items": { - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -33558,21 +43651,35 @@ "tag_operator": { "default": "in", "description": "Operator to compare product tags.", - "enum": ["in", "not_in", "and"], + "enum": [ + "and", + "in", + "not_in" + ], "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable", "variation"], + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/reviews": { @@ -33594,7 +43701,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -33606,14 +43716,23 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "date_gmt", "id", "rating", "product"], + "enum": [ + "date", + "date_gmt", + "id", + "product", + "rating" + ], "required": false, "type": "string" }, @@ -33638,10 +43757,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/tags": { @@ -33658,7 +43781,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -33689,14 +43815,21 @@ "order": { "default": "asc", "description": "Sort ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", - "enum": ["name", "slug", "count"], + "enum": [ + "count", + "name", + "slug" + ], "required": false, "type": "string" }, @@ -33720,10 +43853,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/store/v1" }, "/wc/v1": { @@ -33746,10 +43883,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v1" }, "/wc/v1/coupons": { @@ -33783,7 +43924,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -33818,14 +43962,24 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -33850,7 +44004,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -33872,7 +44028,11 @@ "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -33909,7 +44069,10 @@ "expiry_date": { "description": "UTC DateTime when the coupon expires.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "free_shipping": { "default": false, @@ -33965,20 +44128,28 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/coupons/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/coupons/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -33988,7 +44159,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -34009,7 +44182,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -34045,7 +44222,10 @@ "expiry_date": { "description": "UTC DateTime when the coupon expires.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", @@ -34104,7 +44284,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -34120,10 +44304,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/coupons/batch": { @@ -34154,7 +44346,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -34190,7 +44386,10 @@ "expiry_date": { "description": "UTC DateTime when the coupon expires.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", @@ -34244,10 +44443,18 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/customers": { @@ -34264,7 +44471,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -34300,14 +44510,22 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by object attribute.", - "enum": ["id", "include", "name", "registered_date"], + "enum": [ + "id", + "include", + "name", + "registered_date" + ], "required": false, "type": "string" }, @@ -34330,14 +44548,14 @@ "default": "customer", "description": "Limit result set to resources with a specific role.", "enum": [ - "all", "administrator", - "editor", + "all", "author", "contributor", - "subscriber", "customer", - "shop_manager" + "editor", + "shop_manager", + "subscriber" ], "required": false, "type": "string" @@ -34348,7 +44566,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -34356,58 +44576,91 @@ "description": "List of billing address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -34439,47 +44692,74 @@ "description": "List of shipping address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -34493,20 +44773,27 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/customers/(?P\u003Ccustomer_id\u003E[\\d]+)/downloads": { + "/wc/v1/customers/(?P[\\d]+)/downloads": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -34516,20 +44803,27 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v1" }, - "/wc/v1/customers/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/customers/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -34539,7 +44833,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -34547,58 +44843,91 @@ "description": "List of billing address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -34636,47 +44965,74 @@ "description": "List of shipping address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -34690,7 +45046,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -34712,10 +45072,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/customers/batch": { @@ -34733,58 +45101,91 @@ "description": "List of billing address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -34817,47 +45218,74 @@ "description": "List of shipping address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -34871,10 +45299,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/orders": { @@ -34903,7 +45339,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -34949,14 +45388,24 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -34990,20 +45439,22 @@ "description": "Limit result set to orders assigned a specific status.", "enum": [ "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -35011,58 +45462,91 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -35075,23 +45559,43 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" @@ -35130,8 +45634,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -35289,46 +45793,81 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -35340,12 +45879,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "type": "string" } @@ -35360,33 +45905,56 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line item meta data.", "items": { "properties": { "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta label.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", "readonly": true, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -35395,68 +45963,120 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "string" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "readonly": true, "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -35468,17 +46088,26 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -35513,47 +46142,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -35566,34 +46222,68 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -35605,12 +46295,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -35625,14 +46321,14 @@ "default": "pending", "description": "Order status.", "enum": [ + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -35643,20 +46339,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/orders/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/orders/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -35666,7 +46370,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -35674,58 +46380,91 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -35738,23 +46477,43 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" @@ -35792,8 +46551,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -35950,46 +46709,81 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -36001,12 +46795,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "type": "string" } @@ -36026,33 +46826,56 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line item meta data.", "items": { "properties": { "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta label.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", "readonly": true, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -36061,68 +46884,120 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "string" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "readonly": true, "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -36134,17 +47009,26 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -36178,47 +47062,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -36231,34 +47142,68 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -36270,12 +47215,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -36289,14 +47240,14 @@ "status": { "description": "Order status.", "enum": [ + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -36307,7 +47258,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -36323,20 +47278,31 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, - "/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/notes": { + "/wc/v1/orders/(?P[\\d]+)/notes": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -36346,7 +47312,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -36367,20 +47335,28 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/notes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/orders/(?P[\\d]+)/notes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -36395,7 +47371,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -36416,13 +47394,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/v1" }, - "/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds": { + "/wc/v1/orders/(?P[\\d]+)/refunds": { "endpoints": [ { "args": { @@ -36441,7 +47424,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -36487,7 +47473,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -36499,7 +47488,14 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -36533,20 +47529,22 @@ "description": "Limit result set to orders assigned a specific status.", "enum": [ "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -36566,20 +47564,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/orders/(?P[\\d]+)/refunds/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -36594,7 +47600,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -36615,10 +47623,15 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/v1" }, "/wc/v1/orders/batch": { @@ -36636,58 +47649,91 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -36700,23 +47746,43 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" @@ -36754,8 +47820,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -36912,46 +47978,81 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -36963,12 +48064,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "type": "string" } @@ -36983,33 +48090,56 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line item meta data.", "items": { "properties": { "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta label.", "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", "readonly": true, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -37018,68 +48148,120 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", "readonly": true, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "string" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "readonly": true, "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -37091,17 +48273,26 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -37135,47 +48326,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1.", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2.", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -37188,34 +48406,68 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -37227,12 +48479,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -37246,14 +48504,14 @@ "status": { "description": "Order status.", "enum": [ + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -37264,10 +48522,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products": { @@ -37311,7 +48577,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -37346,14 +48615,24 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -37395,7 +48674,14 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -37406,12 +48692,19 @@ }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -37420,33 +48713,51 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -37460,7 +48771,11 @@ "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -37472,7 +48787,12 @@ "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -37481,18 +48801,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -37526,17 +48855,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -37555,17 +48893,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -37588,7 +48935,9 @@ "download_type": { "default": "standard", "description": "Download type, this controls the schema on the front-end.", - "enum": ["standard"], + "enum": [ + "standard" + ], "required": false, "type": "string" }, @@ -37603,17 +48952,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -37640,39 +48998,66 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -37760,7 +49145,13 @@ "status": { "default": "publish", "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -37774,18 +49165,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -37804,14 +49204,23 @@ "tax_status": { "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -37828,22 +49237,34 @@ "items": { "properties": { "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -37853,62 +49274,105 @@ "type": "array" }, "backordered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on back-order.", "readonly": true, "type": "boolean" }, "backorders": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "type": "string" }, "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if back-orders are allowed.", "readonly": true, "type": "boolean" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Start date of sale price.", "type": "string" }, "date_on_sale_to": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "End data of sale price.", "type": "string" }, "dimensions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -37916,40 +49380,61 @@ "type": "object" }, "download_expiry": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": null, "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "download_limit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": null, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "downloadable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of downloadable files.", "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -37959,49 +49444,82 @@ "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -38010,98 +49528,153 @@ "type": "object" }, "in_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Stock management at variation level.", "type": "boolean" }, "on_sale": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on sale.", "readonly": true, "type": "boolean" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation URL.", "format": "uri", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current variation price.", "readonly": true, "type": "string" }, "purchasable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation can be bought.", "readonly": true, "type": "boolean" }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation regular price.", "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation sale price.", "type": "string" }, "shipping_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping class slug.", "type": "string" }, "shipping_class_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping class ID.", "readonly": true, "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier.", "type": "string" }, "stock_quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock quantity.", "type": "integer" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "type": "string" }, "virtual": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is virtual.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If the variation is visible.", "type": "boolean" }, "weight": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation weight (kg).", "type": "string" } @@ -38123,20 +49696,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/products/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -38146,7 +49727,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -38155,33 +49738,51 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -38194,7 +49795,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -38205,7 +49810,12 @@ }, "catalog_visibility": { "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -38214,18 +49824,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -38259,17 +49878,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -38288,17 +49916,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -38318,7 +49955,9 @@ }, "download_type": { "description": "Download type, this controls the schema on the front-end.", - "enum": ["standard"], + "enum": [ + "standard" + ], "required": false, "type": "string" }, @@ -38332,17 +49971,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -38373,39 +50021,66 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -38488,7 +50163,13 @@ }, "status": { "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -38502,18 +50183,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -38531,13 +50221,22 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -38554,22 +50253,34 @@ "items": { "properties": { "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -38579,62 +50290,105 @@ "type": "array" }, "backordered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on back-order.", "readonly": true, "type": "boolean" }, "backorders": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "type": "string" }, "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if back-orders are allowed.", "readonly": true, "type": "boolean" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Start date of sale price.", "type": "string" }, "date_on_sale_to": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "End data of sale price.", "type": "string" }, "dimensions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -38642,40 +50396,61 @@ "type": "object" }, "download_expiry": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": null, "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "download_limit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": null, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "downloadable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of downloadable files.", "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -38685,49 +50460,82 @@ "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -38736,98 +50544,153 @@ "type": "object" }, "in_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Stock management at variation level.", "type": "boolean" }, "on_sale": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on sale.", "readonly": true, "type": "boolean" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation URL.", "format": "uri", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current variation price.", "readonly": true, "type": "string" }, "purchasable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation can be bought.", "readonly": true, "type": "boolean" }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation regular price.", "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation sale price.", "type": "string" }, "shipping_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping class slug.", "type": "string" }, "shipping_class_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping class ID.", "readonly": true, "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier.", "type": "string" }, "stock_quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock quantity.", "type": "integer" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "type": "string" }, "virtual": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is virtual.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If the variation is visible.", "type": "boolean" }, "weight": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation weight (kg).", "type": "string" } @@ -38848,7 +50711,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -38864,20 +50731,31 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, - "/wc/v1/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews": { + "/wc/v1/products/(?P[\\d]+)/reviews": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -38892,14 +50770,19 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "email": { "description": "Email of the reviewer.", @@ -38932,20 +50815,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/products/(?P[\\d]+)/reviews/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -38960,14 +50851,19 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "email": { "description": "Reviewer email.", @@ -39000,7 +50896,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -39021,10 +50921,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products/attributes": { @@ -39041,12 +50949,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -39064,7 +50977,12 @@ "order_by": { "default": "menu_order", "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -39076,18 +50994,25 @@ "type": { "default": "select", "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { + "/wc/v1/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { @@ -39099,7 +51024,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -39135,14 +51063,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -39183,7 +51122,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -39213,13 +51154,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { "endpoints": [ { "args": { @@ -39231,7 +51177,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -39241,7 +51190,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -39276,7 +51227,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -39297,13 +51252,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, - "/wc/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": { + "/wc/v1/products/attributes/(?P[\\d]+)/terms/batch": { "endpoints": [ { "args": { @@ -39333,20 +51296,31 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, - "/wc/v1/products/attributes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -39356,7 +51330,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -39377,7 +51353,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -39388,12 +51369,18 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -39409,10 +51396,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products/attributes/batch": { @@ -39438,7 +51433,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -39449,15 +51449,25 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products/batch": { @@ -39476,33 +51486,51 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -39515,7 +51543,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -39526,7 +51558,12 @@ }, "catalog_visibility": { "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -39535,18 +51572,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -39580,17 +51626,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -39609,17 +51664,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -39639,7 +51703,9 @@ }, "download_type": { "description": "Download type, this controls the schema on the front-end.", - "enum": ["standard"], + "enum": [ + "standard" + ], "required": false, "type": "string" }, @@ -39653,17 +51719,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -39689,39 +51764,66 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -39804,7 +51906,13 @@ }, "status": { "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -39818,18 +51926,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -39847,13 +51964,22 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -39870,22 +51996,34 @@ "items": { "properties": { "attributes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -39895,62 +52033,105 @@ "type": "array" }, "backordered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on back-order.", "readonly": true, "type": "boolean" }, "backorders": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "type": "string" }, "backorders_allowed": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if back-orders are allowed.", "readonly": true, "type": "boolean" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the variation was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Start date of sale price.", "type": "string" }, "date_on_sale_to": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "End data of sale price.", "type": "string" }, "dimensions": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -39958,40 +52139,61 @@ "type": "object" }, "download_expiry": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": null, "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "download_limit": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": null, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "downloadable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of downloadable files.", "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -40001,49 +52203,82 @@ "type": "array" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -40052,98 +52287,153 @@ "type": "object" }, "in_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Stock management at variation level.", "type": "boolean" }, "on_sale": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation is on sale.", "readonly": true, "type": "boolean" }, "permalink": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation URL.", "format": "uri", "readonly": true, "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Current variation price.", "readonly": true, "type": "string" }, "purchasable": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shows if the variation can be bought.", "readonly": true, "type": "boolean" }, "regular_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation regular price.", "type": "string" }, "sale_price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation sale price.", "type": "string" }, "shipping_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping class slug.", "type": "string" }, "shipping_class_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping class ID.", "readonly": true, "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Unique identifier.", "type": "string" }, "stock_quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Stock quantity.", "type": "integer" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "type": "string" }, "virtual": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "If the variation is virtual.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "If the variation is visible.", "type": "boolean" }, "weight": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation weight (kg).", "type": "string" } @@ -40164,10 +52454,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products/categories": { @@ -40184,7 +52482,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -40220,14 +52521,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -40268,7 +52580,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -40280,7 +52594,12 @@ "display": { "default": "default", "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -40288,35 +52607,59 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" } @@ -40345,20 +52688,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/products/categories/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -40368,7 +52719,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -40379,7 +52732,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -40392,35 +52750,59 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" } @@ -40449,7 +52831,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -40465,10 +52851,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products/categories/batch": { @@ -40489,7 +52883,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -40497,35 +52896,59 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" } @@ -40554,10 +52977,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products/shipping_classes": { @@ -40574,7 +53005,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -40610,14 +53044,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -40658,7 +53103,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -40678,20 +53125,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/products/shipping_classes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/products/shipping_classes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -40701,7 +53156,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -40726,7 +53183,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -40742,10 +53203,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products/shipping_classes/batch": { @@ -40775,10 +53244,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products/tags": { @@ -40795,7 +53272,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -40831,14 +53311,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -40879,7 +53370,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -40899,20 +53392,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/products/tags/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/products/tags/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -40922,7 +53423,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -40947,7 +53450,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -40963,10 +53470,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/products/tags/batch": { @@ -40996,10 +53511,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/reports": { @@ -41016,15 +53539,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v1" }, "/wc/v1/reports/sales": { @@ -41041,7 +53570,9 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -41059,15 +53590,24 @@ }, "period": { "description": "Report period.", - "enum": ["week", "month", "last_month", "year"], + "enum": [ + "last_month", + "month", + "week", + "year" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v1" }, "/wc/v1/reports/top_sellers": { @@ -41084,7 +53624,9 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -41102,15 +53644,24 @@ }, "period": { "description": "Report period.", - "enum": ["week", "month", "last_month", "year"], + "enum": [ + "last_month", + "month", + "week", + "year" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v1" }, "/wc/v1/taxes": { @@ -41126,14 +53677,21 @@ "args": { "class": { "description": "Sort by tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -41145,14 +53703,21 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", - "enum": ["id", "order", "priority"], + "enum": [ + "id", + "order", + "priority" + ], "required": false, "type": "string" }, @@ -41172,7 +53737,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -41184,7 +53751,11 @@ "class": { "default": "standard", "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -41237,20 +53808,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/taxes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/taxes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -41260,7 +53839,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -41271,7 +53852,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -41326,7 +53911,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -41342,10 +53931,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/taxes/batch": { @@ -41366,7 +53963,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -41416,10 +54017,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v1/taxes/classes": { @@ -41436,12 +54045,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -41451,13 +54065,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/taxes/classes/(?P\u003Cslug\u003E\\w[\\w\\s\\-]*)": { + "/wc/v1/taxes/classes/(?P\\w[\\w\\s\\-]*)": { "endpoints": [ { "args": { @@ -41473,10 +54092,14 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["DELETE"], + "methods": [ + "DELETE" + ], "namespace": "wc/v1" }, "/wc/v1/webhooks": { @@ -41505,7 +54128,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -41535,14 +54161,21 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "title"], + "enum": [ + "date", + "id", + "title" + ], "required": false, "type": "string" }, @@ -41569,12 +54202,19 @@ "status": { "default": "all", "description": "Limit result set to webhooks assigned a specific status.", - "enum": ["all", "active", "paused", "disabled"], + "enum": [ + "active", + "all", + "disabled", + "paused" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -41596,7 +54236,11 @@ "status": { "default": "active", "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "required": false, "type": "string" }, @@ -41606,20 +54250,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v1" }, - "/wc/v1/webhooks/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/webhooks/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -41629,7 +54281,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -41650,7 +54304,11 @@ }, "status": { "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "required": false, "type": "string" }, @@ -41660,7 +54318,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -41676,20 +54338,31 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, - "/wc/v1/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries": { + "/wc/v1/webhooks/(?P[\\d]+)/deliveries": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -41699,20 +54372,27 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v1" }, - "/wc/v1/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v1/webhooks/(?P[\\d]+)/deliveries/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -41727,10 +54407,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v1" }, "/wc/v1/webhooks/batch": { @@ -41756,7 +54440,11 @@ }, "status": { "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "required": false, "type": "string" }, @@ -41766,10 +54454,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v1" }, "/wc/v2": { @@ -41792,10 +54488,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, "/wc/v2/coupons": { @@ -41829,7 +54529,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -41877,14 +54580,24 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -41909,7 +54622,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -41926,12 +54641,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -41941,7 +54662,11 @@ "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -42002,20 +54727,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -42060,20 +54802,28 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/coupons/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/coupons/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -42083,7 +54833,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -42100,12 +54852,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -42114,7 +54872,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -42177,20 +54939,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -42235,7 +55014,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -42251,10 +55034,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/coupons/batch": { @@ -42281,12 +55072,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -42295,7 +55092,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -42353,20 +55154,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -42411,10 +55229,18 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/customers": { @@ -42431,7 +55257,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -42467,14 +55296,22 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by object attribute.", - "enum": ["id", "include", "name", "registered_date"], + "enum": [ + "id", + "include", + "name", + "registered_date" + ], "required": false, "type": "string" }, @@ -42497,14 +55334,14 @@ "default": "customer", "description": "Limit result set to resources with a specific role.", "enum": [ - "all", "administrator", - "editor", + "all", "author", "contributor", - "subscriber", "customer", - "shop_manager" + "editor", + "shop_manager", + "subscriber" ], "required": false, "type": "string" @@ -42515,7 +55352,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -42523,58 +55362,91 @@ "description": "List of billing address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -42602,20 +55474,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -42632,47 +55521,74 @@ "description": "List of shipping address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -42686,20 +55602,27 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/customers/(?P\u003Ccustomer_id\u003E[\\d]+)/downloads": { + "/wc/v2/customers/(?P[\\d]+)/downloads": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -42709,20 +55632,27 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, - "/wc/v2/customers/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/customers/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -42732,7 +55662,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -42740,58 +55672,91 @@ "description": "List of billing address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -42825,20 +55790,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -42855,47 +55837,74 @@ "description": "List of shipping address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -42909,7 +55918,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -42931,10 +55944,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/customers/batch": { @@ -42952,58 +55973,91 @@ "description": "List of billing address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -43032,20 +56086,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -43062,47 +56133,74 @@ "description": "List of shipping address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -43116,10 +56214,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/orders": { @@ -43148,7 +56254,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -43225,7 +56334,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -43238,7 +56350,14 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -43290,22 +56409,24 @@ "description": "Limit result set to orders assigned a specific status.", "enum": [ "any", - "trash", "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -43313,58 +56434,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -43377,59 +56534,103 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -43437,7 +56638,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -43476,8 +56679,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -43635,31 +56838,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -43667,40 +56893,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -43712,12 +56970,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -43733,22 +56997,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -43758,35 +57034,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -43794,70 +57096,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -43868,18 +57225,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -43894,20 +57260,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -43940,47 +57323,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -43993,36 +57403,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44030,28 +57466,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -44063,12 +57530,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -44084,14 +57557,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -44102,20 +57575,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/orders/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/orders/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -44125,7 +57606,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -44133,58 +57616,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -44197,59 +57716,103 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44257,7 +57820,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -44295,8 +57860,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -44453,31 +58018,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44485,40 +58073,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -44530,12 +58150,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -44556,22 +58182,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -44581,35 +58219,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44617,70 +58281,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -44691,18 +58410,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -44717,20 +58445,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44762,47 +58507,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -44815,36 +58587,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -44852,28 +58650,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -44885,12 +58714,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -44905,14 +58740,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -44923,7 +58758,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -44939,20 +58778,31 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/notes": { + "/wc/v2/orders/(?P[\\d]+)/notes": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -44964,12 +58814,18 @@ "type": { "default": "any", "description": "Limit result to customers or internal notes.", - "enum": ["any", "customer", "internal"], + "enum": [ + "any", + "customer", + "internal" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -44990,20 +58846,28 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/notes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/orders/(?P[\\d]+)/notes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -45018,7 +58882,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -45039,13 +58905,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/v2" }, - "/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds": { + "/wc/v2/orders/(?P[\\d]+)/refunds": { "endpoints": [ { "args": { @@ -45064,7 +58935,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -45136,7 +59010,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -45154,7 +59031,14 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -45197,7 +59081,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -45217,31 +59103,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -45249,40 +59158,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -45294,12 +59235,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -45315,20 +59262,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -45356,36 +59320,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -45393,28 +59383,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -45426,12 +59447,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -45443,20 +59470,28 @@ "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/orders/(?P[\\d]+)/refunds/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -45471,7 +59506,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -45492,10 +59529,15 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/v2" }, "/wc/v2/orders/batch": { @@ -45513,58 +59555,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -45577,59 +59655,103 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -45637,7 +59759,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -45675,8 +59799,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -45833,31 +59957,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -45865,40 +60012,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -45910,12 +60089,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -45931,22 +60116,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -45956,35 +60153,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -45992,70 +60215,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -46066,18 +60344,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -46092,20 +60379,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -46137,47 +60441,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -46190,36 +60521,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -46227,28 +60584,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -46260,12 +60648,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -46280,14 +60674,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -46298,10 +60692,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/payment_gateways": { @@ -46318,25 +60720,35 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, - "/wc/v2/payment_gateways/(?P\u003Cid\u003E[\\w-]+)": { + "/wc/v2/payment_gateways/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -46346,7 +60758,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -46374,62 +60788,86 @@ "description": "Payment gateway settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", + "checkbox", "color", - "password", - "textarea", - "select", - "multiselect", - "radio", + "email", "image_width", - "checkbox" + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Setting value.", "type": "string" } @@ -46443,10 +60881,19 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products": { @@ -46490,7 +60937,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -46581,7 +61031,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -46592,14 +61045,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -46660,7 +61113,15 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -46671,12 +61132,19 @@ }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -46685,17 +61153,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -46703,18 +61180,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -46728,7 +61214,11 @@ "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -46740,7 +61230,12 @@ "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -46749,18 +61244,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -46782,39 +61286,60 @@ "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -46833,17 +61358,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -46874,17 +61408,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -46919,51 +61462,90 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -46996,20 +61578,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -47077,7 +61676,13 @@ "status": { "default": "publish", "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -47091,18 +61696,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -47121,14 +61735,23 @@ "tax_status": { "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -47152,20 +61775,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/products/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -47175,7 +61806,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -47184,17 +61817,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -47202,18 +61844,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -47226,7 +61877,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -47237,7 +61892,12 @@ }, "catalog_visibility": { "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -47246,18 +61906,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -47279,39 +61948,60 @@ "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -47330,17 +62020,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -47368,17 +62067,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -47417,51 +62125,90 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -47492,20 +62239,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -47570,7 +62334,13 @@ }, "status": { "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -47584,18 +62354,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -47613,13 +62392,22 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -47642,7 +62430,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -47658,20 +62450,31 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews": { + "/wc/v2/products/(?P[\\d]+)/reviews": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -47686,19 +62489,27 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "email": { "description": "Email of the reviewer.", @@ -47731,20 +62542,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/products/(?P[\\d]+)/reviews/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -47759,19 +62578,27 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "email": { "description": "Reviewer email.", @@ -47804,7 +62631,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -47825,25 +62656,39 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews/batch": { + "/wc/v2/products/(?P[\\d]+)/reviews/batch": { "endpoints": [ { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "email": { "description": "Reviewer email.", @@ -47871,13 +62716,21 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations": { + "/wc/v2/products/(?P[\\d]+)/variations": { "endpoints": [ { "args": { @@ -47911,7 +62764,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -48002,14 +62858,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -48074,7 +62941,15 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -48085,12 +62960,19 @@ }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -48099,17 +62981,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -48122,29 +63013,45 @@ "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -48155,17 +63062,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -48196,17 +63112,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -48220,51 +63145,90 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -48283,7 +63247,15 @@ "default": false, "description": "Stock management at variation level.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "menu_order": { "description": "Menu order, used to custom sort products.", @@ -48295,20 +63267,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -48354,7 +63343,11 @@ "tax_status": { "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, @@ -48376,20 +63369,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/products/(?P[\\d]+)/variations/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -48404,7 +63405,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -48413,17 +63416,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -48435,29 +63447,45 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -48468,17 +63496,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -48506,17 +63543,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -48535,51 +63581,90 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -48596,7 +63681,15 @@ "manage_stock": { "description": "Stock management at variation level.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "menu_order": { "description": "Menu order, used to custom sort products.", @@ -48608,20 +63701,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -48666,7 +63776,11 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, @@ -48686,7 +63800,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -48707,13 +63825,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/batch": { + "/wc/v2/products/(?P[\\d]+)/variations/batch": { "endpoints": [ { "args": { @@ -48722,17 +63848,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -48744,29 +63879,45 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -48777,17 +63928,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -48815,17 +63975,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -48839,51 +64008,90 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -48900,7 +64108,15 @@ "manage_stock": { "description": "Stock management at variation level.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "menu_order": { "description": "Menu order, used to custom sort products.", @@ -48912,20 +64128,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -48970,7 +64203,11 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, @@ -48990,10 +64227,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products/attributes": { @@ -49010,12 +64255,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -49033,7 +64283,12 @@ "order_by": { "default": "menu_order", "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -49045,18 +64300,25 @@ "type": { "default": "select", "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { + "/wc/v2/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { @@ -49068,7 +64330,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -49104,14 +64369,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -49152,7 +64428,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -49182,13 +64460,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { "endpoints": [ { "args": { @@ -49200,7 +64483,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -49210,7 +64496,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -49245,7 +64533,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -49266,13 +64558,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": { + "/wc/v2/products/attributes/(?P[\\d]+)/terms/batch": { "endpoints": [ { "args": { @@ -49302,20 +64602,31 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/products/attributes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -49325,7 +64636,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -49346,7 +64659,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -49357,12 +64675,18 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -49378,10 +64702,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products/attributes/batch": { @@ -49407,7 +64739,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -49418,15 +64755,25 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products/batch": { @@ -49445,17 +64792,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -49463,18 +64819,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -49487,7 +64852,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -49498,7 +64867,12 @@ }, "catalog_visibility": { "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -49507,18 +64881,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -49540,39 +64923,60 @@ "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -49591,17 +64995,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -49629,17 +65042,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -49673,51 +65095,90 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -49748,20 +65209,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -49826,7 +65304,13 @@ }, "status": { "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future"], + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -49840,18 +65324,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -49869,13 +65362,22 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -49898,10 +65400,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products/categories": { @@ -49918,7 +65428,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -49954,14 +65467,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -50002,7 +65526,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -50014,7 +65540,12 @@ "display": { "default": "default", "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -50022,47 +65553,83 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" } @@ -50091,20 +65658,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/products/categories/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -50114,7 +65689,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -50125,7 +65702,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -50138,47 +65720,83 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" } @@ -50207,7 +65825,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -50223,10 +65845,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products/categories/batch": { @@ -50247,7 +65877,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -50255,47 +65890,83 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" } @@ -50324,10 +65995,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products/shipping_classes": { @@ -50344,7 +66023,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -50380,14 +66062,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -50428,7 +66121,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -50448,20 +66143,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/products/shipping_classes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/products/shipping_classes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -50471,7 +66174,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -50496,7 +66201,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -50512,10 +66221,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products/shipping_classes/batch": { @@ -50545,10 +66262,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products/tags": { @@ -50565,7 +66290,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -50601,14 +66329,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -50649,7 +66388,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -50669,20 +66410,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/products/tags/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/products/tags/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -50692,7 +66441,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -50717,7 +66468,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -50733,10 +66488,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/products/tags/batch": { @@ -50766,10 +66529,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/reports": { @@ -50786,15 +66557,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, "/wc/v2/reports/sales": { @@ -50811,7 +66588,9 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -50829,15 +66608,24 @@ }, "period": { "description": "Report period.", - "enum": ["week", "month", "last_month", "year"], + "enum": [ + "last_month", + "month", + "week", + "year" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, "/wc/v2/reports/top_sellers": { @@ -50854,7 +66642,9 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -50872,15 +66662,24 @@ }, "period": { "description": "Report period.", - "enum": ["week", "month", "last_month", "year"], + "enum": [ + "last_month", + "month", + "week", + "year" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, "/wc/v2/settings": { @@ -50894,13 +66693,17 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, - "/wc/v2/settings/(?P\u003Cgroup_id\u003E[\\w-]+)": { + "/wc/v2/settings/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -50910,13 +66713,17 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, - "/wc/v2/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/(?P\u003Cid\u003E[\\w-]+)": { + "/wc/v2/settings/(?P[\\w-]+)/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -50931,7 +66738,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -50948,16 +66757,33 @@ "value": { "description": "Setting value.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/batch": { + "/wc/v2/settings/(?P[\\w-]+)/batch": { "endpoints": [ { "args": { @@ -50969,13 +66795,29 @@ "value": { "description": "Setting value.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/shipping/zones": { @@ -50989,7 +66831,9 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51004,13 +66848,18 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/shipping/zones/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/shipping/zones/(?P[\\d]+)": { "endpoints": [ { "args": { @@ -51020,7 +66869,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51040,7 +66891,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -51056,13 +66911,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/shipping/zones/(?P\u003Cid\u003E[\\d]+)/locations": { + "/wc/v2/shipping/zones/(?P[\\d]+)/locations": { "endpoints": [ { "args": { @@ -51072,7 +66935,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51088,18 +66953,32 @@ }, "type": { "description": "Shipping zone location type.", - "enum": ["postcode", "state", "country", "continent"], + "enum": [ + "continent", + "country", + "postcode", + "state" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods": { + "/wc/v2/shipping/zones/(?P[\\d]+)/methods": { "endpoints": [ { "args": { @@ -51109,7 +66988,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51131,62 +67012,86 @@ "description": "Shipping method settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", + "checkbox", "color", - "password", - "textarea", - "select", - "multiselect", - "radio", + "email", "image_width", - "checkbox" + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Setting value.", "type": "string" } @@ -51200,13 +67105,18 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods/(?P\u003Cinstance_id\u003E[\\d]+)": { + "/wc/v2/shipping/zones/(?P[\\d]+)/methods/(?P[\\d]+)": { "endpoints": [ { "args": { @@ -51221,7 +67131,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51244,62 +67156,86 @@ "description": "Shipping method settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", + "checkbox", "color", - "password", - "textarea", - "select", - "multiselect", - "radio", + "email", "image_width", - "checkbox" + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Setting value.", "type": "string" } @@ -51313,7 +67249,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -51334,10 +67274,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/shipping_methods": { @@ -51354,25 +67302,33 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, - "/wc/v2/shipping_methods/(?P\u003Cid\u003E[\\w-]+)": { + "/wc/v2/shipping_methods/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -51382,10 +67338,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, "/wc/v2/system_status": { @@ -51402,15 +67362,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, "/wc/v2/system_status/tools": { @@ -51427,18 +67393,25 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, - "/wc/v2/system_status/tools/(?P\u003Cid\u003E[\\w-]+)": { + "/wc/v2/system_status/tools/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -51448,7 +67421,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51483,10 +67458,19 @@ "type": "boolean" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/taxes": { @@ -51502,14 +67486,21 @@ "args": { "class": { "description": "Sort by tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -51521,14 +67512,21 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", - "enum": ["id", "order", "priority"], + "enum": [ + "id", + "order", + "priority" + ], "required": false, "type": "string" }, @@ -51548,7 +67546,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51560,7 +67560,11 @@ "class": { "default": "standard", "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -51613,20 +67617,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/taxes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/taxes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -51636,7 +67648,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51647,7 +67661,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -51702,7 +67720,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -51718,10 +67740,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/taxes/batch": { @@ -51742,7 +67772,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -51792,10 +67826,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v2/taxes/classes": { @@ -51812,12 +67854,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51827,13 +67874,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/taxes/classes/(?P\u003Cslug\u003E\\w[\\w\\s\\-]*)": { + "/wc/v2/taxes/classes/(?P\\w[\\w\\s\\-]*)": { "endpoints": [ { "args": { @@ -51843,7 +67895,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51859,10 +67913,15 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/v2" }, "/wc/v2/webhooks": { @@ -51891,7 +67950,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -51921,14 +67983,21 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "title"], + "enum": [ + "date", + "id", + "title" + ], "required": false, "type": "string" }, @@ -51955,12 +68024,19 @@ "status": { "default": "all", "description": "Limit result set to webhooks assigned a specific status.", - "enum": ["all", "active", "paused", "disabled"], + "enum": [ + "active", + "all", + "disabled", + "paused" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -51982,7 +68058,11 @@ "status": { "default": "active", "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "required": false, "type": "string" }, @@ -51992,20 +68072,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v2" }, - "/wc/v2/webhooks/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/webhooks/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -52015,7 +68103,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -52036,7 +68126,11 @@ }, "status": { "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "required": false, "type": "string" }, @@ -52046,7 +68140,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -52062,20 +68160,31 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, - "/wc/v2/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries": { + "/wc/v2/webhooks/(?P[\\d]+)/deliveries": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -52085,20 +68194,27 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, - "/wc/v2/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v2/webhooks/(?P[\\d]+)/deliveries/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -52113,10 +68229,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v2" }, "/wc/v2/webhooks/batch": { @@ -52142,7 +68262,11 @@ }, "status": { "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "required": false, "type": "string" }, @@ -52152,10 +68276,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v2" }, "/wc/v3": { @@ -52178,10 +68310,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/coupons": { @@ -52215,7 +68351,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -52263,14 +68402,24 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -52295,7 +68444,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -52312,12 +68463,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -52327,7 +68484,11 @@ "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -52388,20 +68549,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -52446,20 +68624,28 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/coupons/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/coupons/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -52469,7 +68655,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -52486,12 +68674,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -52500,7 +68694,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -52563,20 +68761,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -52621,7 +68836,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -52637,10 +68856,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/coupons/batch": { @@ -52667,12 +68894,18 @@ "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Coupon description.", @@ -52681,7 +68914,11 @@ }, "discount_type": { "description": "Determines the type of discount that will be applied.", - "enum": ["percent", "fixed_cart", "fixed_product"], + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], "required": false, "type": "string" }, @@ -52739,20 +68976,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -52797,10 +69051,18 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/customers": { @@ -52817,7 +69079,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -52853,14 +69118,22 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by object attribute.", - "enum": ["id", "include", "name", "registered_date"], + "enum": [ + "id", + "include", + "name", + "registered_date" + ], "required": false, "type": "string" }, @@ -52883,14 +69156,14 @@ "default": "customer", "description": "Limit result set to resources with a specific role.", "enum": [ - "all", "administrator", - "editor", + "all", "author", "contributor", - "subscriber", "customer", - "shop_manager" + "editor", + "shop_manager", + "subscriber" ], "required": false, "type": "string" @@ -52901,7 +69174,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -52909,58 +69184,91 @@ "description": "List of billing address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -52988,20 +69296,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53018,52 +69343,82 @@ "description": "List of shipping address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -53077,20 +69432,27 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/customers/(?P\u003Ccustomer_id\u003E[\\d]+)/downloads": { + "/wc/v3/customers/(?P[\\d]+)/downloads": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -53100,20 +69462,27 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/customers/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/customers/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -53123,7 +69492,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -53131,58 +69502,91 @@ "description": "List of billing address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -53216,20 +69620,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53246,52 +69667,82 @@ "description": "List of shipping address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -53305,7 +69756,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -53327,10 +69782,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/customers/batch": { @@ -53348,58 +69811,91 @@ "description": "List of billing address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -53428,20 +69924,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -53458,52 +69971,82 @@ "description": "List of shipping address data.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code of the country.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -53517,10 +70060,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/data": { @@ -53534,10 +70085,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/data/continents": { @@ -53551,13 +70106,17 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/data/continents/(?P\u003Clocation\u003E[\\w-]+)": { + "/wc/v3/data/continents/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -53567,10 +70126,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/data/countries": { @@ -53584,13 +70147,17 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/data/countries/(?P\u003Clocation\u003E[\\w-]+)": { + "/wc/v3/data/countries/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -53600,10 +70167,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/data/currencies": { @@ -53617,13 +70188,17 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/data/currencies/(?P\u003Ccurrency\u003E[\\w-]{3})": { + "/wc/v3/data/currencies/(?P[\\w-]{3})": { "endpoints": [ { "args": { @@ -53633,10 +70208,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/data/currencies/current": { @@ -53650,10 +70229,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/layout-templates": { @@ -53674,13 +70257,17 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/layout-templates/(?P\u003Cid\u003E\\w[\\w\\s\\-]*)": { + "/wc/v3/layout-templates/(?P\\w[\\w\\s\\-]*)": { "endpoints": [ { "args": { @@ -53690,10 +70277,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/marketplace/create-order": { @@ -53711,10 +70302,14 @@ "required": true } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/v3" }, "/wc/v3/marketplace/featured": { @@ -53728,10 +70323,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/marketplace/refresh": { @@ -53745,10 +70344,14 @@ "endpoints": [ { "args": [], - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions": { @@ -53762,10 +70365,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions/activate": { @@ -53784,10 +70391,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions/connect": { @@ -53806,10 +70417,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions/disconnect": { @@ -53828,10 +70443,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions/install-url": { @@ -53850,10 +70469,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/orders": { @@ -53882,7 +70505,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -53959,7 +70585,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -53972,7 +70601,14 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -54025,16 +70661,16 @@ "items": { "enum": [ "any", - "trash", "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" + "trash" ], "type": "string" }, @@ -54042,7 +70678,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -54050,58 +70688,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -54114,60 +70788,104 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -54175,7 +70893,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -54214,8 +70934,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -54373,31 +71093,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -54405,40 +71148,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -54450,12 +71225,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -54471,22 +71252,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -54496,35 +71289,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -54532,70 +71351,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -54606,18 +71480,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -54638,20 +71521,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -54684,47 +71584,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -54737,36 +71664,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -54774,28 +71727,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -54807,12 +71791,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -54828,14 +71818,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -54846,20 +71836,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/orders/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/orders/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -54869,7 +71867,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -54877,58 +71877,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -54941,60 +71977,104 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -55002,7 +72082,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -55040,8 +72122,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -55198,31 +72280,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -55230,40 +72335,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -55275,12 +72412,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -55301,22 +72444,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -55326,35 +72481,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -55362,70 +72543,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -55436,18 +72672,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -55467,20 +72712,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -55512,47 +72774,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -55565,36 +72854,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -55602,28 +72917,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -55635,12 +72981,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -55655,14 +73007,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -55673,7 +73025,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -55689,13 +73045,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, - "/wc/v3/orders/(?P\u003Cid\u003E[\\d]+)/receipt": { + "/wc/v3/orders/(?P[\\d]+)/receipt": { "endpoints": [ { "args": { @@ -55723,7 +73087,9 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": { @@ -55733,20 +73099,28 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["POST", "GET"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/notes": { + "/wc/v3/orders/(?P[\\d]+)/notes": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -55758,12 +73132,18 @@ "type": { "default": "any", "description": "Limit result to customers or internal notes.", - "enum": ["any", "customer", "internal"], + "enum": [ + "any", + "customer", + "internal" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -55790,20 +73170,28 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/notes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/orders/(?P[\\d]+)/notes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -55818,7 +73206,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -55839,13 +73229,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds": { + "/wc/v3/orders/(?P[\\d]+)/refunds": { "endpoints": [ { "args": { @@ -55864,7 +73259,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -55936,7 +73334,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -55954,7 +73355,14 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -55997,7 +73405,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -56023,31 +73433,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -56055,40 +73488,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -56100,12 +73565,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -56121,20 +73592,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -56162,36 +73650,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -56199,28 +73713,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -56232,12 +73777,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -56249,20 +73800,28 @@ "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/orders/(?P[\\d]+)/refunds/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -56277,7 +73836,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -56298,10 +73859,15 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/orders/batch": { @@ -56319,58 +73885,94 @@ "description": "Billing address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Email address.", "format": "email", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "phone": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Phone number.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -56383,60 +73985,104 @@ "items": { "properties": { "code": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Coupon code.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "discount": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { - "context": ["view"], + "context": [ + "view" + ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -56444,7 +74090,9 @@ "type": "array" }, "nominal_amount": { - "context": ["view"], + "context": [ + "view" + ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" @@ -56482,8 +74130,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -56640,31 +74288,54 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -56672,40 +74343,72 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Fee name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax status of fee.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -56717,12 +74420,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -56738,22 +74447,34 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Properties of the main product image.", "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -56763,35 +74484,61 @@ "type": "object" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "display_key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value for UI display.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -56799,70 +74546,125 @@ "type": "array" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "parent_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "quantity": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Quantity ordered.", "type": "integer" }, "sku": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax class of product.", "type": "string" }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax subtotal.", "type": "string" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "type": "string" } @@ -56873,18 +74675,27 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation ID, if applicable.", "type": "integer" } @@ -56904,20 +74715,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -56949,47 +74777,74 @@ "description": "Shipping address.", "properties": { "address_1": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 1", "type": "string" }, "address_2": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Address line 2", "type": "string" }, "city": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "City name.", "type": "string" }, "company": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Company name.", "type": "string" }, "country": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "First name.", "type": "string" }, "last_name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Last name.", "type": "string" }, "postcode": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Postal code.", "type": "string" }, "state": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } @@ -57002,36 +74857,62 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta data.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -57039,28 +74920,59 @@ "type": "array" }, "method_id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method ID.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "method_title": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Shipping method name.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, "taxes": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line taxes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tax total.", "readonly": true, "type": "string" @@ -57072,12 +74984,18 @@ "type": "array" }, "total": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" @@ -57092,14 +75010,14 @@ "description": "Order status.", "enum": [ "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "refunded" ], "required": false, "type": "string" @@ -57110,10 +75028,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/payment_gateways": { @@ -57130,25 +75056,35 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/payment_gateways/(?P\u003Cid\u003E[\\w-]+)": { + "/wc/v3/payment_gateways/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -57158,7 +75094,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -57186,62 +75124,86 @@ "description": "Payment gateway settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", + "checkbox", "color", - "password", - "textarea", - "select", - "multiselect", - "radio", + "email", "image_width", - "checkbox" + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Setting value.", "type": "string" } @@ -57255,10 +75217,19 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products": { @@ -57302,7 +75273,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -57388,7 +75362,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -57399,17 +75376,17 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", - "rating", - "menu_order", + "popularity", "price", - "popularity", - "rating" + "rating", + "rating", + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -57475,13 +75452,25 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -57492,12 +75481,19 @@ }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -57506,17 +75502,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -57524,18 +75529,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -57549,7 +75563,11 @@ "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -57561,7 +75579,12 @@ "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -57570,18 +75593,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -57603,49 +75635,76 @@ "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -57664,17 +75723,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -57705,17 +75773,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -57747,46 +75824,82 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -57800,7 +75913,10 @@ "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "default": false, @@ -57818,20 +75934,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -57904,7 +76037,15 @@ "status": { "default": "publish", "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -57916,7 +76057,11 @@ "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -57925,18 +76070,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -57955,14 +76109,23 @@ "tax_status": { "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -57986,20 +76149,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/products/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -58009,7 +76180,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -58018,17 +76191,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -58036,18 +76218,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -58060,7 +76251,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -58071,7 +76266,12 @@ }, "catalog_visibility": { "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -58080,18 +76280,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -58113,49 +76322,76 @@ "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -58174,17 +76410,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -58212,17 +76457,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -58258,46 +76512,82 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -58311,7 +76601,10 @@ "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "description": "Stock management at product level.", @@ -58328,20 +76621,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -58411,7 +76721,15 @@ }, "status": { "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -58422,7 +76740,11 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -58431,18 +76753,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -58460,13 +76791,22 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -58489,7 +76829,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -58505,13 +76849,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, - "/wc/v3/products/(?P\u003Cid\u003E[\\d]+)/duplicate": { + "/wc/v3/products/(?P[\\d]+)/duplicate": { "endpoints": [ { "args": { @@ -58520,17 +76872,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -58538,18 +76899,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -58562,7 +76932,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -58573,7 +76947,12 @@ }, "catalog_visibility": { "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -58582,18 +76961,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -58615,49 +77003,76 @@ "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -58676,17 +77091,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -58714,17 +77138,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -58760,46 +77193,82 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -58813,7 +77282,10 @@ "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "description": "Stock management at product level.", @@ -58830,20 +77302,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -58913,7 +77402,15 @@ }, "status": { "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -58924,7 +77421,11 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -58933,18 +77434,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -58962,13 +77472,22 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -58991,13 +77510,17 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations": { + "/wc/v3/products/(?P[\\d]+)/variations": { "endpoints": [ { "args": { @@ -59038,7 +77561,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -59124,14 +77650,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"], + "enum": [ + "date", + "id", + "include", + "menu_order", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -59191,18 +77728,32 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -59211,17 +77762,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -59234,29 +77794,45 @@ "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -59267,17 +77843,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -59308,17 +77893,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -59337,46 +77931,82 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -59388,7 +78018,10 @@ "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "default": false, @@ -59406,20 +78039,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -59455,7 +78105,12 @@ "status": { "default": "publish", "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "enum": [ + "draft", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -59467,7 +78122,11 @@ "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -59479,7 +78138,11 @@ "tax_status": { "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, @@ -59495,20 +78158,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/products/(?P[\\d]+)/variations/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -59523,7 +78194,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -59532,17 +78205,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -59554,29 +78236,45 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -59587,17 +78285,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -59625,17 +78332,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -59659,46 +78375,82 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -59710,7 +78462,10 @@ "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "description": "Stock management at variation level.", @@ -59727,20 +78482,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -59775,7 +78547,12 @@ }, "status": { "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "enum": [ + "draft", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -59786,7 +78563,11 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -59797,7 +78578,11 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, @@ -59812,7 +78597,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -59833,13 +78622,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, - "/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/batch": { + "/wc/v3/products/(?P[\\d]+)/variations/batch": { "endpoints": [ { "args": { @@ -59848,17 +78645,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -59870,29 +78676,45 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "description": { "description": "Variation description.", @@ -59903,17 +78725,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -59941,17 +78772,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -59970,46 +78810,82 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -60021,7 +78897,10 @@ "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "description": "Stock management at variation level.", @@ -60038,20 +78917,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -60086,7 +78982,12 @@ }, "status": { "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "enum": [ + "draft", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -60097,7 +78998,11 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -60108,7 +79013,11 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, @@ -60123,13 +79032,21 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, - "/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/generate": { + "/wc/v3/products/(?P[\\d]+)/variations/generate": { "endpoints": [ { "args": { @@ -60138,17 +79055,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -60161,29 +79087,45 @@ "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_values": { "description": "Default values for generated variations.", @@ -60193,17 +79135,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -60216,7 +79167,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -60224,25 +79179,37 @@ "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], + "type": [ + "null", + "string" + ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], + "type": [ + "null", + "string" + ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], + "type": [ + "null", + "string" + ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", - "type": ["null", "string"], + "type": [ + "null", + "string" + ], "validate_callback": "rest_validate_request_arg" }, "description": { @@ -60255,17 +79222,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -60297,17 +79273,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -60328,46 +79313,82 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -60380,7 +79401,10 @@ "low_stock_amount": { "description": "Low Stock amount for the variation.", "sanitize_callback": "rest_sanitize_request_arg", - "type": ["integer", "null"], + "type": [ + "integer", + "null" + ], "validate_callback": "rest_validate_request_arg" }, "manage_stock": { @@ -60400,20 +79424,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -60448,7 +79489,12 @@ }, "status": { "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "enum": [ + "draft", + "pending", + "private", + "publish" + ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -60461,7 +79507,11 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -60474,7 +79524,11 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" @@ -60509,17 +79563,26 @@ "description": "Variation dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Variation width (cm).", "type": "string" } @@ -60550,17 +79613,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -60579,46 +79651,82 @@ "description": "Variation image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -60630,7 +79738,10 @@ "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "default": false, @@ -60648,20 +79759,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -60697,7 +79825,12 @@ "status": { "default": "publish", "description": "Variation status.", - "enum": ["draft", "pending", "private", "publish"], + "enum": [ + "draft", + "pending", + "private", + "publish" + ], "required": false, "type": "string" }, @@ -60709,7 +79842,11 @@ "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -60721,7 +79858,11 @@ "tax_status": { "default": "taxable", "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, @@ -60737,10 +79878,14 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wc/v3" }, "/wc/v3/products/attributes": { @@ -60757,12 +79902,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -60780,7 +79930,12 @@ "order_by": { "default": "menu_order", "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -60792,18 +79947,25 @@ "type": { "default": "select", "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { + "/wc/v3/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { @@ -60815,7 +79977,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -60851,14 +80016,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -60899,7 +80075,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -60929,13 +80107,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { "endpoints": [ { "args": { @@ -60947,7 +80130,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -60957,7 +80143,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -60992,7 +80180,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -61013,13 +80205,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, - "/wc/v3/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": { + "/wc/v3/products/attributes/(?P[\\d]+)/terms/batch": { "endpoints": [ { "args": { @@ -61049,20 +80249,31 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, - "/wc/v3/products/attributes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -61072,7 +80283,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -61093,7 +80306,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -61104,12 +80322,18 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -61125,10 +80349,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/attributes/batch": { @@ -61154,7 +80386,12 @@ }, "order_by": { "description": "Default sort order.", - "enum": ["menu_order", "name", "name_num", "id"], + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], "required": false, "type": "string" }, @@ -61165,15 +80402,25 @@ }, "type": { "description": "Type of attribute.", - "enum": ["select"], + "enum": [ + "select" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/batch": { @@ -61192,17 +80439,26 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "options": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "List of available term names of the attribute.", "items": { "type": "string" @@ -61210,18 +80466,27 @@ "type": "array" }, "position": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute position.", "type": "integer" }, "variation": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" @@ -61234,7 +80499,11 @@ }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", - "enum": ["no", "notify", "yes"], + "enum": [ + "no", + "notify", + "yes" + ], "required": false, "type": "string" }, @@ -61245,7 +80514,12 @@ }, "catalog_visibility": { "description": "Catalogue visibility.", - "enum": ["visible", "catalog", "search", "hidden"], + "enum": [ + "catalog", + "hidden", + "search", + "visible" + ], "required": false, "type": "string" }, @@ -61254,18 +80528,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Category slug.", "readonly": true, "type": "string" @@ -61287,49 +80570,76 @@ "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Attribute name.", "type": "string" }, "option": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Selected attribute term name.", "type": "string" } @@ -61348,17 +80658,26 @@ "description": "Product dimensions.", "properties": { "height": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product height (cm).", "type": "string" }, "length": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product length (cm).", "type": "string" }, "width": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Product width (cm).", "type": "string" } @@ -61386,17 +80705,26 @@ "items": { "properties": { "file": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File URL.", "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File ID.", "type": "string" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "File name.", "type": "string" } @@ -61427,46 +80755,82 @@ "items": { "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -61480,7 +80844,10 @@ "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "manage_stock": { "description": "Stock management at product level.", @@ -61497,20 +80864,37 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta key.", "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Meta value.", - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, "type": "object" @@ -61580,7 +80964,15 @@ }, "status": { "description": "Product status (post status).", - "enum": ["draft", "pending", "private", "publish", "future", "auto-draft", "trash"], + "enum": [ + "auto-draft", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -61591,7 +80983,11 @@ }, "stock_status": { "description": "Controls the stock status of the product.", - "enum": ["instock", "outofstock", "onbackorder"], + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], "required": false, "type": "string" }, @@ -61600,18 +80996,27 @@ "items": { "properties": { "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Tag slug.", "readonly": true, "type": "string" @@ -61629,13 +81034,22 @@ }, "tax_status": { "description": "Tax status.", - "enum": ["taxable", "shipping", "none"], + "enum": [ + "none", + "shipping", + "taxable" + ], "required": false, "type": "string" }, "type": { "description": "Product type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" }, @@ -61658,10 +81072,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/categories": { @@ -61678,7 +81100,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -61714,14 +81139,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -61762,7 +81198,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -61774,7 +81212,12 @@ "display": { "default": "default", "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -61782,46 +81225,82 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -61851,20 +81330,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/products/categories/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -61874,7 +81361,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -61885,7 +81374,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -61898,46 +81392,82 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -61967,7 +81497,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -61983,10 +81517,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/categories/batch": { @@ -62007,7 +81549,12 @@ }, "display": { "description": "Category archive display type.", - "enum": ["default", "products", "subcategories", "both"], + "enum": [ + "both", + "default", + "products", + "subcategories" + ], "required": false, "type": "string" }, @@ -62015,46 +81562,82 @@ "description": "Image data.", "properties": { "alt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image alternative text.", "type": "string" }, "date_created": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_created_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was created, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "date_modified_gmt": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "The date the image was last modified, as GMT.", "readonly": true, - "type": ["null", "string"] + "type": [ + "null", + "string" + ] }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image ID.", "type": "integer" }, "name": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image name.", "type": "string" }, "src": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Image URL.", "format": "uri", "type": "string" @@ -62084,10 +81667,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/custom-fields/names": { @@ -62109,7 +81700,10 @@ "order": { "default": "asc", "description": "Order sort items ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -62134,10 +81728,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/products/reviews": { @@ -62166,7 +81764,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -62196,14 +81797,23 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date_gmt", "description": "Sort collection by object attribute.", - "enum": ["date", "date_gmt", "id", "include", "product"], + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ], "required": false, "type": "string" }, @@ -62262,12 +81872,20 @@ "status": { "default": "approved", "description": "Limit result set to reviews assigned a specific status.", - "enum": ["all", "hold", "approved", "spam", "trash"], + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -62304,25 +81922,40 @@ "status": { "default": "approved", "description": "Status of the review.", - "enum": ["approved", "hold", "spam", "unspam", "trash", "untrash"], + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/products/reviews/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/products/reviews/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -62332,7 +81965,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -62374,12 +82009,23 @@ }, "status": { "description": "Status of the review.", - "enum": ["approved", "hold", "spam", "unspam", "trash", "untrash"], + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -62395,10 +82041,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/reviews/batch": { @@ -62445,15 +82099,30 @@ }, "status": { "description": "Status of the review.", - "enum": ["approved", "hold", "spam", "unspam", "trash", "untrash"], + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/shipping_classes": { @@ -62470,7 +82139,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -62506,14 +82178,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -62554,7 +82237,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -62574,20 +82259,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/products/shipping_classes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/products/shipping_classes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -62597,7 +82290,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -62622,7 +82317,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -62638,10 +82337,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/shipping_classes/batch": { @@ -62671,10 +82378,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/shipping_classes/slug-suggestion": { @@ -62704,10 +82419,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/products/suggested-products": { @@ -62760,7 +82479,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -62857,7 +82579,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -62868,14 +82593,14 @@ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", "rating", - "menu_order" + "rating", + "slug", + "title" ], "required": false, "type": "string" @@ -62936,7 +82661,15 @@ "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", - "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"], + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ], "required": false, "type": "string" }, @@ -62956,15 +82689,24 @@ }, "type": { "description": "Limit result set to products assigned a specific type.", - "enum": ["simple", "grouped", "external", "variable"], + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/products/tags": { @@ -62981,7 +82723,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -63017,14 +82762,25 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", - "enum": ["id", "include", "name", "slug", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -63065,7 +82821,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -63085,20 +82843,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/products/tags/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/products/tags/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -63108,7 +82874,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -63133,7 +82901,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -63149,10 +82921,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/products/tags/batch": { @@ -63182,10 +82962,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/refunds": { @@ -63214,7 +83002,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -63286,7 +83077,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -63299,7 +83093,14 @@ "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "title", "slug", "modified"], + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -63342,10 +83143,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/reports": { @@ -63362,15 +83167,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/reports/coupons/totals": { @@ -63387,15 +83198,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/reports/customers/totals": { @@ -63412,15 +83229,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/reports/orders/totals": { @@ -63437,15 +83260,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/reports/products/totals": { @@ -63462,15 +83291,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/reports/reviews/totals": { @@ -63487,15 +83322,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/reports/sales": { @@ -63512,7 +83353,9 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -63530,15 +83373,24 @@ }, "period": { "description": "Report period.", - "enum": ["week", "month", "last_month", "year"], + "enum": [ + "last_month", + "month", + "week", + "year" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/reports/top_sellers": { @@ -63555,7 +83407,9 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -63573,15 +83427,24 @@ }, "period": { "description": "Report period.", - "enum": ["week", "month", "last_month", "year"], + "enum": [ + "last_month", + "month", + "week", + "year" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/settings": { @@ -63595,13 +83458,17 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/settings/(?P\u003Cgroup_id\u003E[\\w-]+)": { + "/wc/v3/settings/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -63611,13 +83478,17 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/(?P\u003Cid\u003E[\\w-]+)": { + "/wc/v3/settings/(?P[\\w-]+)/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -63632,7 +83503,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -63649,16 +83522,33 @@ "value": { "description": "Setting value.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, - "/wc/v3/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/batch": { + "/wc/v3/settings/(?P[\\w-]+)/batch": { "endpoints": [ { "args": { @@ -63670,13 +83560,29 @@ "value": { "description": "Setting value.", "required": false, - "type": ["null", "object", "string", "number", "boolean", "integer", "array"] + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/settings/batch": { @@ -63690,10 +83596,18 @@ "endpoints": [ { "args": [], - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/shipping/zones": { @@ -63707,7 +83621,9 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -63722,13 +83638,18 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/shipping/zones/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/shipping/zones/(?P[\\d]+)": { "endpoints": [ { "args": { @@ -63738,7 +83659,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -63758,7 +83681,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -63774,13 +83701,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, - "/wc/v3/shipping/zones/(?P\u003Cid\u003E[\\d]+)/locations": { + "/wc/v3/shipping/zones/(?P[\\d]+)/locations": { "endpoints": [ { "args": { @@ -63790,7 +83725,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -63806,18 +83743,32 @@ }, "type": { "description": "Shipping zone location type.", - "enum": ["postcode", "state", "country", "continent"], + "enum": [ + "continent", + "country", + "postcode", + "state" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, - "/wc/v3/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods": { + "/wc/v3/shipping/zones/(?P[\\d]+)/methods": { "endpoints": [ { "args": { @@ -63827,7 +83778,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -63849,64 +83802,88 @@ "description": "Shipping method settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", "checkbox", "class", - "order" + "color", + "email", + "image_width", + "multiselect", + "number", + "order", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Setting value.", "type": "string" } @@ -63920,13 +83897,18 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods/(?P\u003Cinstance_id\u003E[\\d]+)": { + "/wc/v3/shipping/zones/(?P[\\d]+)/methods/(?P[\\d]+)": { "endpoints": [ { "args": { @@ -63941,7 +83923,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -63964,64 +83948,88 @@ "description": "Shipping method settings.", "properties": { "default": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Type of setting.", "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", "checkbox", "class", - "order" + "color", + "email", + "image_width", + "multiselect", + "number", + "order", + "password", + "radio", + "select", + "text", + "textarea" ], "readonly": true, "type": "string" }, "value": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Setting value.", "type": "string" } @@ -64035,7 +84043,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -64056,10 +84068,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/shipping_methods": { @@ -64076,25 +84096,33 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/shipping_methods/(?P\u003Cid\u003E[\\w-]+)": { + "/wc/v3/shipping_methods/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -64104,10 +84132,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/system_status": { @@ -64124,15 +84156,21 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/system_status/tools": { @@ -64149,18 +84187,25 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wc/v3" }, - "/wc/v3/system_status/tools/(?P\u003Cid\u003E[\\w-]+)": { + "/wc/v3/system_status/tools/(?P[\\w-]+)": { "endpoints": [ { "args": { @@ -64170,7 +84215,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -64205,10 +84252,19 @@ "type": "boolean" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/taxes": { @@ -64224,14 +84280,21 @@ "args": { "class": { "description": "Sort by tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -64243,14 +84306,21 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", - "enum": ["id", "order", "priority"], + "enum": [ + "id", + "order", + "priority" + ], "required": false, "type": "string" }, @@ -64270,7 +84340,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -64290,7 +84362,11 @@ "class": { "default": "standard", "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -64351,20 +84427,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/taxes/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/taxes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -64374,7 +84458,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -64393,7 +84479,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -64456,7 +84546,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -64472,10 +84566,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/taxes/batch": { @@ -64504,7 +84606,11 @@ }, "class": { "description": "Tax class.", - "enum": ["standard", "reduced-rate", "zero-rate"], + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], "required": false, "type": "string" }, @@ -64562,10 +84668,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/taxes/classes": { @@ -64582,12 +84696,17 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -64597,13 +84716,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/taxes/classes/(?P\u003Cslug\u003E\\w[\\w\\s\\-]*)": { + "/wc/v3/taxes/classes/(?P\\w[\\w\\s\\-]*)": { "endpoints": [ { "args": { @@ -64613,7 +84737,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -64629,10 +84755,15 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wc/v3" }, "/wc/v3/webhooks": { @@ -64661,7 +84792,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -64691,14 +84825,21 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "title"], + "enum": [ + "date", + "id", + "title" + ], "required": false, "type": "string" }, @@ -64725,12 +84866,19 @@ "status": { "default": "all", "description": "Limit result set to webhooks assigned a specific status.", - "enum": ["all", "active", "paused", "disabled"], + "enum": [ + "active", + "all", + "disabled", + "paused" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -64752,7 +84900,11 @@ "status": { "default": "active", "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "required": false, "type": "string" }, @@ -64762,20 +84914,28 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wc/v3" }, - "/wc/v3/webhooks/(?P\u003Cid\u003E[\\d]+)": { + "/wc/v3/webhooks/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "edit"], + "enum": [ + "edit", + "view" + ], "required": false, "type": "string" }, @@ -64785,7 +84945,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -64806,7 +84968,11 @@ }, "status": { "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "required": false, "type": "string" }, @@ -64816,7 +84982,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -64832,10 +85002,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wc/v3/webhooks/batch": { @@ -64861,7 +85039,11 @@ }, "status": { "description": "Webhook status.", - "enum": ["active", "paused", "disabled"], + "enum": [ + "active", + "disabled", + "paused" + ], "required": false, "type": "string" }, @@ -64871,10 +85053,18 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wc/v3" }, "/wccom-site/v3": { @@ -64897,10 +85087,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wccom-site/v3" }, "/wccom-site/v3/installer": { @@ -64923,15 +85117,29 @@ "type": "integer" }, "run-until-step": { - "enum": ["get_product_info", "download_product", "unpack_product", "move_product", "activate_product"], + "enum": [ + "activate_product", + "download_product", + "get_product_info", + "move_product", + "unpack_product" + ], "required": true, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wccom-site/v3" }, "/wccom-site/v3/installer/reset": { @@ -64954,10 +85162,18 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["POST", "PUT", "PATCH"], + "methods": [ + "PATCH", + "POST", + "PUT" + ], "namespace": "wccom-site/v3" }, "/wccom-site/v3/ssr": { @@ -64971,10 +85187,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wccom-site/v3" }, "/wccom-site/v3/status": { @@ -64988,10 +85208,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wccom-site/v3" }, "/wp-block-editor/v1": { @@ -65014,10 +85238,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-block-editor/v1" }, "/wp-block-editor/v1/export": { @@ -65031,10 +85259,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-block-editor/v1" }, "/wp-block-editor/v1/navigation-fallback": { @@ -65048,10 +85280,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-block-editor/v1" }, "/wp-block-editor/v1/url-details": { @@ -65072,10 +85308,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-block-editor/v1" }, "/wp-site-health/v1": { @@ -65098,10 +85338,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/directory-sizes": { @@ -65115,10 +85359,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/authorization-header": { @@ -65132,10 +85380,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/background-updates": { @@ -65149,10 +85401,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/dotorg-communication": { @@ -65166,10 +85422,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/https-status": { @@ -65183,10 +85443,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/loopback-requests": { @@ -65200,10 +85464,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/page-cache": { @@ -65217,10 +85485,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp-site-health/v1" }, "/wp/v2": { @@ -65243,10 +85515,14 @@ "required": false } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/block-directory/search": { @@ -65263,7 +85539,9 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view"], + "enum": [ + "view" + ], "required": false, "type": "string" }, @@ -65289,10 +85567,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/block-patterns/categories": { @@ -65306,10 +85588,14 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/block-patterns/patterns": { @@ -65323,13 +85609,17 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/block-renderer/(?P\u003Cname\u003E[a-z0-9-]+/[a-z0-9-]+)": { + "/wp/v2/block-renderer/(?P[a-z0-9-]+/[a-z0-9-]+)": { "endpoints": [ { "args": { @@ -65342,7 +85632,9 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["edit"], + "enum": [ + "edit" + ], "required": false, "type": "string" }, @@ -65357,10 +85649,16 @@ "type": "integer" } }, - "methods": ["GET", "POST"] + "methods": [ + "GET", + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, "/wp/v2/block-types": { @@ -65377,7 +85675,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -65387,20 +85689,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/block-types/(?P\u003Cnamespace\u003E[a-zA-Z0-9_-]+)": { + "/wp/v2/block-types/(?P[a-zA-Z0-9_-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -65410,20 +85720,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/block-types/(?P\u003Cnamespace\u003E[a-zA-Z0-9_-]+)/(?P\u003Cname\u003E[a-zA-Z0-9_-]+)": { + "/wp/v2/block-types/(?P[a-zA-Z0-9_-]+)/(?P[a-zA-Z0-9_-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -65438,10 +85756,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/blocks": { @@ -65473,7 +85795,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -65515,7 +85841,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -65527,11 +85856,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ], "required": false, @@ -65561,7 +85890,11 @@ "default": [], "description": "Array of column names to be searched.", "items": { - "enum": ["post_title", "post_content", "post_excerpt"], + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], "type": "string" }, "required": false, @@ -65580,27 +85913,27 @@ "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" }, @@ -65609,7 +85942,10 @@ }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "required": false, "type": "string" }, @@ -65631,7 +85967,10 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { @@ -65648,7 +85987,10 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "wp_pattern_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.", @@ -65679,10 +86021,15 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -65693,19 +86040,28 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the post, as it exists in the database.", "type": "string" } @@ -65717,30 +86073,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -65760,7 +86132,10 @@ "wp_pattern_sync_status": { "default": "", "description": "", - "enum": ["partial", "unsynced"], + "enum": [ + "partial", + "unsynced" + ], "type": "string" } }, @@ -65780,19 +86155,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -65806,7 +86181,10 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Title for the object, as it exists in the database.", "type": "string" } @@ -65823,13 +86201,18 @@ "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/blocks/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/blocks/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -65839,7 +86222,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -65859,7 +86246,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -65870,19 +86259,28 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the post, as it exists in the database.", "type": "string" } @@ -65894,30 +86292,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -65942,7 +86356,10 @@ "wp_pattern_sync_status": { "default": "", "description": "", - "enum": ["partial", "unsynced"], + "enum": [ + "partial", + "unsynced" + ], "type": "string" } }, @@ -65962,19 +86379,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -65988,7 +86405,10 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Title for the object, as it exists in the database.", "type": "string" } @@ -66005,7 +86425,11 @@ "type": "array" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -66024,20 +86448,32 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/blocks/(?P\u003Cid\u003E[\\d]+)/autosaves": { + "/wp/v2/blocks/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -66047,7 +86483,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -66055,19 +86493,28 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the post, as it exists in the database.", "type": "string" } @@ -66079,30 +86526,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -66122,7 +86585,10 @@ "wp_pattern_sync_status": { "default": "", "description": "", - "enum": ["partial", "unsynced"], + "enum": [ + "partial", + "unsynced" + ], "type": "string" } }, @@ -66147,19 +86613,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -66173,7 +86639,10 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Title for the object, as it exists in the database.", "type": "string" } @@ -66190,20 +86659,29 @@ "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/blocks/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/blocks/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -66218,20 +86696,28 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/blocks/(?P\u003Cparent\u003E[\\d]+)/revisions": { + "/wp/v2/blocks/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -66261,14 +86747,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"], + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -66297,20 +86794,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/blocks/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/blocks/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -66325,7 +86830,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -66346,10 +86853,15 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/categories": { @@ -66369,7 +86881,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -66400,14 +86916,26 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -66451,7 +86979,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -66485,13 +87015,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/categories/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/categories/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -66501,7 +87036,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -66511,7 +87050,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -66550,7 +87091,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -66569,10 +87114,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/comments": { @@ -66624,7 +87177,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -66654,14 +87211,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date_gmt", "description": "Sort collection by comment attribute.", - "enum": ["date", "date_gmt", "id", "include", "post", "parent", "type"], + "enum": [ + "date", + "date_gmt", + "id", + "include", + "parent", + "post", + "type" + ], "required": false, "type": "string" }, @@ -66730,7 +87298,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -66771,12 +87341,18 @@ "description": "The content for the comment.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the comment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the comment, transformed for display.", "readonly": true, "type": "string" @@ -66821,20 +87397,29 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/comments/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/comments/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -66849,7 +87434,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -66890,12 +87477,18 @@ "description": "The content for the comment.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the comment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the comment, transformed for display.", "readonly": true, "type": "string" @@ -66943,7 +87536,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -66964,10 +87561,18 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/font-collections": { @@ -66984,7 +87589,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -67004,28 +87613,40 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/font-collections/(?P\u003Cslug\u003E[\\/\\w-]+)": { + "/wp/v2/font-collections/(?P[\\/\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/font-families": { @@ -67042,7 +87663,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -67072,14 +87697,20 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "id", "description": "Sort collection by post attribute.", - "enum": ["id", "include"], + "enum": [ + "id", + "include" + ], "required": false, "type": "string" }, @@ -67107,7 +87738,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -67125,20 +87758,29 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/font-families/(?P\u003Cfont_family_id\u003E[\\d]+)/font-faces": { + "/wp/v2/font-families/(?P[\\d]+)/font-faces": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -67173,14 +87815,20 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "id", "description": "Sort collection by post attribute.", - "enum": ["id", "include"], + "enum": [ + "id", + "include" + ], "required": false, "type": "string" }, @@ -67200,7 +87848,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -67223,20 +87873,29 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/font-families/(?P\u003Cfont_family_id\u003E[\\d]+)/font-faces/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/font-families/(?P[\\d]+)/font-faces/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -67251,7 +87910,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -67272,20 +87933,29 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/font-families/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/font-families/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -67295,7 +87965,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -67318,7 +87990,11 @@ "type": "integer" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -67334,13 +88010,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/global-styles/(?P\u003Cid\u003E[\\/\\w-]+)": { + "/wp/v2/global-styles/(?P[\\/\\w-]+)": { "endpoints": [ { "allow_batch": { @@ -67353,7 +88037,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -67363,46 +88049,74 @@ "settings": { "description": "Global settings.", "required": false, - "type": ["object"] + "type": [ + "object" + ] }, "styles": { "description": "Global styles.", "required": false, - "type": ["object"] + "type": [ + "object" + ] }, "title": { "description": "Title of the global styles variation.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the global styles variation, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/global-styles/(?P\u003Cparent\u003E[\\d]+)/revisions": { + "/wp/v2/global-styles/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -67431,20 +88145,28 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/global-styles/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/global-styles/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -67459,13 +88181,17 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/global-styles/themes/(?P\u003Cstylesheet\u003E[\\/\\s%\\w\\.\\(\\)\\[\\]\\@_\\-]+)/variations": { + "/wp/v2/global-styles/themes/(?P[\\/\\s%\\w\\.\\(\\)\\[\\]\\@_\\-]+)/variations": { "endpoints": [ { "allow_batch": { @@ -67478,13 +88204,17 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/global-styles/themes/(?P\u003Cstylesheet\u003E[^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)": { + "/wp/v2/global-styles/themes/(?P[^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)": { "endpoints": [ { "allow_batch": { @@ -67497,10 +88227,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/media": { @@ -67547,7 +88281,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -67572,7 +88310,11 @@ "media_type": { "default": null, "description": "Limit result set to attachments of a particular media type.", - "enum": ["image", "video", "application"], + "enum": [ + "application", + "image", + "video" + ], "required": false, "type": "string" }, @@ -67602,7 +88344,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -67614,11 +88359,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ], "required": false, @@ -67666,7 +88411,11 @@ "default": [], "description": "Array of column names to be searched.", "items": { - "enum": ["post_title", "post_content", "post_excerpt"], + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], "type": "string" }, "required": false, @@ -67684,14 +88433,20 @@ "default": "inherit", "description": "Limit result set to posts assigned one or more statuses.", "items": { - "enum": ["inherit", "private", "trash"], + "enum": [ + "inherit", + "private", + "trash" + ], "type": "string" }, "required": false, "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -67709,12 +88464,18 @@ "description": "The attachment caption.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Caption for the attachment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML caption for the attachment, transformed for display.", "readonly": true, "type": "string" @@ -67725,7 +88486,10 @@ }, "comment_status": { "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -67733,24 +88497,35 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "description": { "description": "The attachment description.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Description for the attachment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description for the attachment, transformed for display.", "readonly": true, "type": "string" @@ -67772,7 +88547,10 @@ }, "ping_status": { "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -67789,19 +88567,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -67815,12 +88593,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -67830,20 +88614,29 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/media/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/media/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -67853,7 +88646,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -67871,12 +88666,18 @@ "description": "The attachment caption.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Caption for the attachment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML caption for the attachment, transformed for display.", "readonly": true, "type": "string" @@ -67887,7 +88688,10 @@ }, "comment_status": { "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -67895,24 +88699,35 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "description": { "description": "The attachment description.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Description for the attachment, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML description for the attachment, transformed for display.", "readonly": true, "type": "string" @@ -67939,7 +88754,10 @@ }, "ping_status": { "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -67956,19 +88774,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -67982,12 +88800,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -67997,7 +88821,11 @@ "type": "object" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -68013,13 +88841,21 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/media/(?P\u003Cid\u003E[\\d]+)/edit": { + "/wp/v2/media/(?P[\\d]+)/edit": { "endpoints": [ { "args": { @@ -68045,12 +88881,16 @@ "type": "number" } }, - "required": ["angle"], + "required": [ + "angle" + ], "type": "object" }, "type": { "description": "Rotation type.", - "enum": ["rotate"], + "enum": [ + "rotate" + ], "type": "string" } }, @@ -68078,19 +88918,29 @@ "type": "number" } }, - "required": ["left", "top", "width", "height"], + "required": [ + "height", + "left", + "top", + "width" + ], "type": "object" }, "type": { "description": "Crop type.", - "enum": ["crop"], + "enum": [ + "crop" + ], "type": "string" } }, "title": "Crop" } ], - "required": ["type", "args"], + "required": [ + "args", + "type" + ], "type": "object" }, "minItems": 1, @@ -68134,18 +88984,24 @@ "type": "number" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/media/(?P\u003Cid\u003E[\\d]+)/post-process": { + "/wp/v2/media/(?P[\\d]+)/post-process": { "endpoints": [ { "args": { "action": { - "enum": ["create-image-subsizes"], + "enum": [ + "create-image-subsizes" + ], "required": true, "type": "string" }, @@ -68155,10 +89011,14 @@ "type": "integer" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wp/v2" }, "/wp/v2/menu-items": { @@ -68190,7 +89050,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -68235,7 +89099,10 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { @@ -68252,7 +89119,10 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "menus_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.", @@ -68283,7 +89153,10 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", @@ -68305,7 +89178,10 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -68317,13 +89193,13 @@ "date", "id", "include", + "include_slugs", + "menu_order", "modified", "parent", "relevance", "slug", - "include_slugs", - "title", - "menu_order" + "title" ], "required": false, "type": "string" @@ -68352,7 +89228,11 @@ "default": [], "description": "Array of column names to be searched.", "items": { - "enum": ["post_title", "post_content", "post_excerpt"], + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], "type": "string" }, "required": false, @@ -68371,27 +89251,27 @@ "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" }, @@ -68400,12 +89280,17 @@ }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -68471,26 +89356,29 @@ "default": "publish", "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" }, "target": { "description": "The target attribute of the link element for this menu item.", - "enum": ["_blank", ""], + "enum": [ + "", + "_blank" + ], "required": false, "type": "string" }, @@ -68498,24 +89386,38 @@ "description": "The title for the object.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["string", "object"] + "type": [ + "object", + "string" + ] }, "type": { "default": "custom", "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "enum": ["taxonomy", "post_type", "post_type_archive", "custom"], + "enum": [ + "custom", + "post_type", + "post_type_archive", + "taxonomy" + ], "required": false, "type": "string" }, @@ -68534,13 +89436,18 @@ "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/menu-items/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/menu-items/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -68550,7 +89457,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -68560,7 +89471,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -68627,26 +89540,29 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" }, "target": { "description": "The target attribute of the link element for this menu item.", - "enum": ["_blank", ""], + "enum": [ + "", + "_blank" + ], "required": false, "type": "string" }, @@ -68654,23 +89570,37 @@ "description": "The title for the object.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["string", "object"] + "type": [ + "object", + "string" + ] }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "enum": ["taxonomy", "post_type", "post_type_archive", "custom"], + "enum": [ + "custom", + "post_type", + "post_type_archive", + "taxonomy" + ], "required": false, "type": "string" }, @@ -68689,7 +89619,11 @@ "type": "array" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -68708,20 +89642,32 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/menu-items/(?P\u003Cid\u003E[\\d]+)/autosaves": { + "/wp/v2/menu-items/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -68731,7 +89677,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -68790,26 +89738,29 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" }, "target": { "description": "The target attribute of the link element for this menu item.", - "enum": ["_blank", ""], + "enum": [ + "", + "_blank" + ], "required": false, "type": "string" }, @@ -68817,23 +89768,37 @@ "description": "The title for the object.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["string", "object"] + "type": [ + "object", + "string" + ] }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "enum": ["taxonomy", "post_type", "post_type_archive", "custom"], + "enum": [ + "custom", + "post_type", + "post_type_archive", + "taxonomy" + ], "required": false, "type": "string" }, @@ -68852,20 +89817,29 @@ "type": "array" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/menu-items/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/menu-items/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -68880,10 +89854,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/menu-locations": { @@ -68900,25 +89878,37 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/menu-locations/(?P\u003Clocation\u003E[\\w-]+)": { + "/wp/v2/menu-locations/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -68928,10 +89918,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/menus": { @@ -68951,7 +89945,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -68987,14 +89985,26 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -69033,7 +90043,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -69075,13 +90087,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/menus/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/menus/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -69091,7 +90108,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -69101,7 +90122,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -69148,7 +90171,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -69167,10 +90194,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/navigation": { @@ -69202,7 +90237,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -69244,7 +90283,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -69256,11 +90298,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ], "required": false, @@ -69290,7 +90332,11 @@ "default": [], "description": "Array of column names to be searched.", "items": { - "enum": ["post_title", "post_content", "post_excerpt"], + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], "type": "string" }, "required": false, @@ -69309,27 +90355,27 @@ "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" }, @@ -69337,7 +90383,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -69348,24 +90396,38 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -69378,13 +90440,19 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "password": { "description": "A password to protect access to the content and excerpt.", @@ -69399,19 +90467,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -69425,12 +90493,19 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -69440,13 +90515,18 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/navigation/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/navigation/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -69456,7 +90536,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -69471,7 +90555,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -69482,24 +90568,38 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -69512,13 +90612,19 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "id": { "description": "Unique identifier for the post.", @@ -69538,19 +90644,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -69564,12 +90670,19 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -69579,7 +90692,11 @@ "type": "object" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -69598,20 +90715,32 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/navigation/(?P\u003Cid\u003E[\\d]+)/autosaves": { + "/wp/v2/navigation/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -69621,7 +90750,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -69629,24 +90760,38 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -69659,13 +90804,19 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "parent": { "description": "The ID for the parent of the autosave.", @@ -69685,19 +90836,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -69711,12 +90862,19 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit", "embed"], + "context": [ + "edit", + "embed" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -69726,20 +90884,29 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/navigation/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/navigation/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -69754,20 +90921,28 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/navigation/(?P\u003Cparent\u003E[\\d]+)/revisions": { + "/wp/v2/navigation/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -69797,14 +90972,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"], + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -69833,20 +91019,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/navigation/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/navigation/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -69861,7 +91055,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -69882,10 +91078,15 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/pages": { @@ -69935,7 +91136,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -69982,7 +91187,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -69994,13 +91202,13 @@ "date", "id", "include", + "include_slugs", + "menu_order", "modified", "parent", "relevance", "slug", - "include_slugs", - "title", - "menu_order" + "title" ], "required": false, "type": "string" @@ -70047,7 +91255,11 @@ "default": [], "description": "Array of column names to be searched.", "items": { - "enum": ["post_title", "post_content", "post_excerpt"], + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], "type": "string" }, "required": false, @@ -70066,27 +91278,27 @@ "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" }, @@ -70094,7 +91306,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -70108,7 +91322,10 @@ }, "comment_status": { "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -70116,24 +91333,35 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -70146,30 +91374,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -70212,7 +91456,10 @@ }, "ping_status": { "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -70224,19 +91471,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -70250,12 +91497,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -70265,13 +91518,18 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/pages/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/pages/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -70281,7 +91539,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -70301,7 +91563,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -70315,7 +91579,10 @@ }, "comment_status": { "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -70323,24 +91590,35 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -70353,30 +91631,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -70424,7 +91718,10 @@ }, "ping_status": { "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -70436,19 +91733,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -70462,12 +91759,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -70477,7 +91780,11 @@ "type": "object" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -70496,20 +91803,32 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/pages/(?P\u003Cid\u003E[\\d]+)/autosaves": { + "/wp/v2/pages/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -70519,7 +91838,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -70530,7 +91851,10 @@ }, "comment_status": { "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -70538,24 +91862,35 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -70568,30 +91903,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -70634,7 +91985,10 @@ }, "ping_status": { "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -70646,19 +92000,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -70672,12 +92026,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -70687,20 +92047,29 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/pages/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/pages/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -70715,20 +92084,28 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/pages/(?P\u003Cparent\u003E[\\d]+)/revisions": { + "/wp/v2/pages/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -70758,14 +92135,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"], + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -70794,20 +92182,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/pages/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/pages/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -70822,7 +92218,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -70843,10 +92241,15 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/pattern-directory/patterns": { @@ -70869,7 +92272,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -70887,7 +92294,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -70897,15 +92307,15 @@ "enum": [ "author", "date", + "favorite_count", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", - "title", - "favorite_count" + "title" ], "required": false, "type": "string" @@ -70937,10 +92347,14 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/plugins": { @@ -70957,7 +92371,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -70969,14 +92387,19 @@ "status": { "description": "Limits results to plugins with the given status.", "items": { - "enum": ["inactive", "active"], + "enum": [ + "active", + "inactive" + ], "type": "string" }, "required": false, "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -70989,25 +92412,37 @@ "status": { "default": "inactive", "description": "The plugin activation status.", - "enum": ["inactive", "active"], + "enum": [ + "active", + "inactive" + ], "required": false, "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/plugins/(?P\u003Cplugin\u003E[^.\\/]+(?:\\/[^.\\/]+)?)": { + "/wp/v2/plugins/(?P[^.\\/]+(?:\\/[^.\\/]+)?)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -71017,14 +92452,20 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -71035,19 +92476,30 @@ }, "status": { "description": "The plugin activation status.", - "enum": ["inactive", "active"], + "enum": [ + "active", + "inactive" + ], "required": false, "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -71057,10 +92509,18 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/posts": { @@ -71130,7 +92590,10 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { @@ -71147,7 +92610,10 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "categories_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", @@ -71183,12 +92649,19 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -71230,7 +92703,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -71242,11 +92718,11 @@ "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ], "required": false, @@ -71276,7 +92752,11 @@ "default": [], "description": "Array of column names to be searched.", "items": { - "enum": ["post_title", "post_content", "post_excerpt"], + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], "type": "string" }, "required": false, @@ -71295,27 +92775,27 @@ "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" }, @@ -71345,7 +92825,10 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { @@ -71362,7 +92845,10 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "tags_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", @@ -71393,16 +92879,24 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -71424,7 +92918,10 @@ }, "comment_status": { "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -71432,24 +92929,35 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -71462,30 +92970,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -71501,7 +93025,18 @@ }, "format": { "description": "The format for the post.", - "enum": ["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio"], + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], "required": false, "type": "string" }, @@ -71524,7 +93059,10 @@ }, "ping_status": { "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -71536,19 +93074,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -71575,12 +93113,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -71590,13 +93134,18 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/posts/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/posts/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -71606,7 +93155,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -71626,7 +93179,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -71648,7 +93203,10 @@ }, "comment_status": { "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -71656,24 +93214,35 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -71686,30 +93255,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -71725,7 +93310,18 @@ }, "format": { "description": "The format for the post.", - "enum": ["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio"], + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], "required": false, "type": "string" }, @@ -71753,7 +93349,10 @@ }, "ping_status": { "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -71765,19 +93364,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -71804,12 +93403,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -71819,7 +93424,11 @@ "type": "object" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -71838,20 +93447,32 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/posts/(?P\u003Cid\u003E[\\d]+)/autosaves": { + "/wp/v2/posts/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -71861,7 +93482,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -71880,7 +93503,10 @@ }, "comment_status": { "description": "Whether or not comments are open on the post.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -71888,24 +93514,35 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -71918,30 +93555,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -71957,7 +93610,18 @@ }, "format": { "description": "The format for the post.", - "enum": ["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio"], + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], "required": false, "type": "string" }, @@ -71985,7 +93649,10 @@ }, "ping_status": { "description": "Whether or not the post can be pinged.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "type": "string" }, @@ -71997,19 +93664,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -72036,12 +93703,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -72051,20 +93724,29 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/posts/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/posts/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -72079,20 +93761,28 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/posts/(?P\u003Cparent\u003E[\\d]+)/revisions": { + "/wp/v2/posts/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -72122,14 +93812,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"], + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -72158,20 +93859,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/posts/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/posts/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -72186,7 +93895,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -72207,10 +93918,15 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/product": { @@ -72242,7 +93958,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -72284,7 +94004,10 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, @@ -72296,16 +94019,16 @@ "date", "id", "include", + "include_slugs", "modified", "parent", - "relevance", - "slug", - "include_slugs", - "title", + "popularity", "popularity", "rating", - "popularity", - "rating" + "rating", + "relevance", + "slug", + "title" ], "required": false, "type": "string" @@ -72348,7 +94071,10 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { @@ -72365,7 +94091,10 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "product_cat_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.", @@ -72401,7 +94130,10 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "product_tag": { "description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.", @@ -72421,7 +94153,10 @@ "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "type": "string" }, "terms": { @@ -72438,7 +94173,10 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "product_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.", @@ -72469,7 +94207,10 @@ } ], "required": false, - "type": ["object", "array"] + "type": [ + "array", + "object" + ] }, "search": { "description": "Limit results to those matching a string.", @@ -72480,7 +94221,11 @@ "default": [], "description": "Array of column names to be searched.", "items": { - "enum": ["post_title", "post_content", "post_excerpt"], + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], "type": "string" }, "required": false, @@ -72499,27 +94244,27 @@ "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ - "publish", - "future", + "any", + "auto-draft", "draft", + "future", + "inherit", "pending", "private", - "trash", - "auto-draft", - "inherit", - "request-pending", + "publish", + "request-completed", "request-confirmed", "request-failed", - "request-completed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "wc-refunded" ], "type": "string" }, @@ -72528,12 +94273,17 @@ }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", - "enum": ["AND", "OR"], + "enum": [ + "AND", + "OR" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -72544,24 +94294,35 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -72574,30 +94335,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -72646,19 +94423,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -72672,12 +94449,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -72687,13 +94470,18 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/product/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/product/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -72703,7 +94491,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -72723,7 +94515,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -72734,24 +94528,35 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -72764,30 +94569,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -72841,19 +94662,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -72867,12 +94688,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -72882,7 +94709,11 @@ "type": "object" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -72901,20 +94732,32 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/product/(?P\u003Cid\u003E[\\d]+)/autosaves": { + "/wp/v2/product/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -72924,7 +94767,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -72932,24 +94777,35 @@ "description": "The content for the post.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" @@ -72962,30 +94818,46 @@ "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" @@ -73039,19 +94911,19 @@ "status": { "description": "A named status for the object.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -73065,12 +94937,18 @@ "description": "The title for the post.", "properties": { "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" @@ -73080,20 +94958,29 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/product/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/product/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -73108,10 +94995,14 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/product_cat": { @@ -73131,7 +95022,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -73162,14 +95057,26 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -73213,7 +95120,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -73247,13 +95156,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/product_cat/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/product_cat/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -73263,7 +95177,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -73273,7 +95191,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -73312,7 +95232,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -73331,10 +95255,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/product_tag": { @@ -73354,7 +95286,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -73390,14 +95326,26 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -73436,7 +95384,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -73465,13 +95415,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/product_tag/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/product_tag/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -73481,7 +95436,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -73491,7 +95450,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -73525,7 +95486,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -73544,10 +95509,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/search": { @@ -73564,7 +95537,10 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed"], + "enum": [ + "embed", + "view" + ], "required": false, "type": "string" }, @@ -73610,7 +95586,16 @@ "default": "any", "description": "Limit results to items of one or more object subtypes.", "items": { - "enum": ["post", "page", "product", "category", "post_tag", "product_cat", "product_tag", "any"], + "enum": [ + "any", + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], "type": "string" }, "required": false, @@ -73619,15 +95604,23 @@ "type": { "default": "post", "description": "Limit results to items of an object type.", - "enum": ["post", "term", "post-format"], + "enum": [ + "post", + "post-format", + "term" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/settings": { @@ -73641,7 +95634,9 @@ "endpoints": [ { "args": [], - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -73659,14 +95654,20 @@ }, "default_comment_status": { "description": "Allow people to submit comments on new posts.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "title": "Allow comments on new posts", "type": "string" }, "default_ping_status": { "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", - "enum": ["open", "closed"], + "enum": [ + "closed", + "open" + ], "required": false, "title": "", "type": "string" @@ -73718,12 +95719,18 @@ }, "enabled": { "description": "If enabled, this method will appear on the block based checkout.", - "enum": ["yes", "no"], + "enum": [ + "no", + "yes" + ], "type": "string" }, "tax_status": { "description": "If a cost is defined, this controls if taxes are applied to that cost.", - "enum": ["taxable", "none"], + "enum": [ + "none", + "taxable" + ], "type": "string" }, "title": { @@ -73839,10 +95846,19 @@ "type": "boolean" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/sidebars": { @@ -73859,25 +95875,37 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/sidebars/(?P\u003Cid\u003E[\\w-]+)": { + "/wp/v2/sidebars/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -73887,23 +95915,37 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { "widgets": { "description": "Nested widgets.", "items": { - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "required": false, "type": "array" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH"], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/statuses": { @@ -73920,25 +95962,37 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/statuses/(?P\u003Cstatus\u003E[\\w-]+)": { + "/wp/v2/statuses/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -73948,10 +96002,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/tags": { @@ -73971,7 +96029,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74007,14 +96069,26 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -74053,7 +96127,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -74082,13 +96158,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/tags/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/tags/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -74098,7 +96179,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74108,7 +96193,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -74142,7 +96229,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -74161,10 +96252,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/taxonomies": { @@ -74181,7 +96280,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74191,20 +96294,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/taxonomies/(?P\u003Ctaxonomy\u003E[\\w-]+)": { + "/wp/v2/taxonomies/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74214,10 +96325,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/template-parts": { @@ -74239,7 +96354,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74254,7 +96373,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -74273,19 +96394,27 @@ "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { "default": "", @@ -74304,19 +96433,19 @@ "default": "publish", "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -74331,19 +96460,30 @@ "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "type": { "description": "Type of template.", @@ -74351,20 +96491,29 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/template-parts/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)": { + "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74374,7 +96523,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -74392,19 +96543,27 @@ "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { "description": "Description of template.", @@ -74426,19 +96585,19 @@ "status": { "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -74452,19 +96611,30 @@ "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "type": { "description": "Type of template.", @@ -74472,7 +96642,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -74488,20 +96662,32 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/template-parts/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": { + "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74511,7 +96697,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -74529,19 +96717,27 @@ "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { "description": "Description of template.", @@ -74563,19 +96759,19 @@ "status": { "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -74589,19 +96785,30 @@ "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "type": { "description": "Type of template.", @@ -74609,20 +96816,29 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/template-parts/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74637,20 +96853,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/template-parts/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": { + "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74680,14 +96904,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"], + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -74716,20 +96951,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/template-parts/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74744,7 +96987,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -74765,10 +97010,15 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/template-parts/lookup": { @@ -74798,10 +97048,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/templates": { @@ -74823,7 +97077,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74838,7 +97096,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -74852,19 +97112,27 @@ "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { "default": "", @@ -74883,19 +97151,19 @@ "default": "publish", "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -74910,19 +97178,30 @@ "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "type": { "description": "Type of template.", @@ -74930,20 +97209,29 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/templates/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)": { + "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -74953,7 +97241,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -74966,19 +97256,27 @@ "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { "description": "Description of template.", @@ -75000,19 +97298,19 @@ "status": { "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -75026,19 +97324,30 @@ "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "type": { "description": "Type of template.", @@ -75046,7 +97355,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -75062,20 +97375,32 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/templates/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": { + "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -75085,7 +97410,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -75098,19 +97425,27 @@ "description": "Content of template.", "properties": { "block_version": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { - "context": ["view", "edit"], + "context": [ + "edit", + "view" + ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "description": { "description": "Description of template.", @@ -75132,19 +97467,19 @@ "status": { "description": "Status of template.", "enum": [ - "publish", - "future", "draft", + "future", "pending", "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", "wc-pending", "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "wc-refunded" ], "required": false, "type": "string" @@ -75158,19 +97493,30 @@ "description": "Title of template.", "properties": { "raw": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, - "type": ["object", "string"] + "type": [ + "object", + "string" + ] }, "type": { "description": "Type of template.", @@ -75178,20 +97524,29 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/templates/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -75206,20 +97561,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/templates/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": { + "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -75249,14 +97612,25 @@ "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", - "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"], + "enum": [ + "date", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ], "required": false, "type": "string" }, @@ -75285,20 +97659,28 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/templates/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -75313,7 +97695,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -75334,10 +97718,15 @@ "type": "string" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "DELETE"], + "methods": [ + "DELETE", + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/templates/lookup": { @@ -75367,10 +97756,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/themes": { @@ -75387,20 +97780,27 @@ "status": { "description": "Limit result set to themes assigned one or more statuses.", "items": { - "enum": ["active", "inactive"], + "enum": [ + "active", + "inactive" + ], "type": "string" }, "required": false, "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/themes/(?P\u003Cstylesheet\u003E[^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)": { + "/wp/v2/themes/(?P[^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)": { "endpoints": [ { "args": { @@ -75410,10 +97810,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/types": { @@ -75430,25 +97834,37 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/types/(?P\u003Ctype\u003E[\\w-]+)": { + "/wp/v2/types/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -75458,10 +97874,14 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/users": { @@ -75489,7 +97909,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -75522,7 +97946,10 @@ "type": "string" }, "required": false, - "type": ["boolean", "array"] + "type": [ + "array", + "boolean" + ] }, "include": { "default": [], @@ -75541,14 +97968,26 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by user attribute.", - "enum": ["id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url"], + "enum": [ + "email", + "id", + "include", + "include_slugs", + "name", + "registered_date", + "slug", + "url" + ], "required": false, "type": "string" }, @@ -75590,12 +98029,16 @@ }, "who": { "description": "Limit result set to users who are considered authors.", - "enum": ["authors"], + "enum": [ + "authors" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -75625,7 +98068,13 @@ }, "locale": { "description": "Locale for the user.", - "enum": ["", "en_US", "en_GB", "fr_BE", "fr_FR"], + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], "required": false, "type": "string" }, @@ -75634,7 +98083,9 @@ "properties": { "persisted_preferences": { "additionalProperties": true, - "context": ["edit"], + "context": [ + "edit" + ], "default": [], "description": "", "properties": { @@ -75701,13 +98152,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/users/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/users/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -75717,7 +98173,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -75727,7 +98187,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -75762,7 +98224,13 @@ }, "locale": { "description": "Locale for the user.", - "enum": ["", "en_US", "en_GB", "fr_BE", "fr_FR"], + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], "required": false, "type": "string" }, @@ -75771,7 +98239,9 @@ "properties": { "persisted_preferences": { "additionalProperties": true, - "context": ["edit"], + "context": [ + "edit" + ], "default": [], "description": "", "properties": { @@ -75838,7 +98308,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -75862,25 +98336,39 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/users/(?P\u003Cuser_id\u003E(?:[\\d]+|me))/application-passwords": { + "/wp/v2/users/(?P(?:[\\d]+|me))/application-passwords": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -75898,29 +98386,43 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] }, { "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "DELETE"], + "methods": [ + "DELETE", + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/users/(?P\u003Cuser_id\u003E(?:[\\d]+|me))/application-passwords/(?P\u003Cuuid\u003E[\\w\\-]+)": { + "/wp/v2/users/(?P(?:[\\d]+|me))/application-passwords/(?P[\\w\\-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -75938,32 +98440,52 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": [], - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, - "/wp/v2/users/(?P\u003Cuser_id\u003E(?:[\\d]+|me))/application-passwords/introspect": { + "/wp/v2/users/(?P(?:[\\d]+|me))/application-passwords/introspect": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, "/wp/v2/users/me": { @@ -75980,12 +98502,18 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "args": { @@ -76012,7 +98540,13 @@ }, "locale": { "description": "Locale for the user.", - "enum": ["", "en_US", "en_GB", "fr_BE", "fr_FR"], + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], "required": false, "type": "string" }, @@ -76021,7 +98555,9 @@ "properties": { "persisted_preferences": { "additionalProperties": true, - "context": ["edit"], + "context": [ + "edit" + ], "default": [], "description": "", "properties": { @@ -76088,7 +98624,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "args": { @@ -76104,10 +98644,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/widget-types": { @@ -76124,25 +98672,37 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/widget-types/(?P\u003Cid\u003E[a-zA-Z0-9_-]+)": { + "/wp/v2/widget-types/(?P[a-zA-Z0-9_-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -76152,13 +98712,17 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] } ], - "methods": ["GET"], + "methods": [ + "GET" + ], "namespace": "wp/v2" }, - "/wp/v2/widget-types/(?P\u003Cid\u003E[a-zA-Z0-9_-]+)/encode": { + "/wp/v2/widget-types/(?P[a-zA-Z0-9_-]+)/encode": { "endpoints": [ { "args": { @@ -76178,13 +98742,17 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/widget-types/(?P\u003Cid\u003E[a-zA-Z0-9_-]+)/render": { + "/wp/v2/widget-types/(?P[a-zA-Z0-9_-]+)/render": { "endpoints": [ { "args": { @@ -76199,10 +98767,14 @@ "type": "object" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["POST"], + "methods": [ + "POST" + ], "namespace": "wp/v2" }, "/wp/v2/widgets": { @@ -76222,7 +98794,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -76232,7 +98808,9 @@ "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -76258,17 +98836,23 @@ "description": "Instance settings of the widget, if supported.", "properties": { "encoded": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Base64 encoded representation of the instance settings.", "type": "string" }, "hash": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Cryptographic hash of the instance settings.", "type": "string" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Unencoded instance settings, if supported.", "type": "object" } @@ -76283,13 +98867,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/widgets/(?P\u003Cid\u003E[\\w\\-]+)": { + "/wp/v2/widgets/(?P[\\w\\-]+)": { "endpoints": [ { "allow_batch": { @@ -76299,12 +98888,18 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -76330,17 +98925,23 @@ "description": "Instance settings of the widget, if supported.", "properties": { "encoded": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Base64 encoded representation of the instance settings.", "type": "string" }, "hash": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Cryptographic hash of the instance settings.", "type": "string" }, "raw": { - "context": ["edit"], + "context": [ + "edit" + ], "description": "Unencoded instance settings, if supported.", "type": "object" } @@ -76354,7 +98955,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -76367,10 +98972,18 @@ "type": "boolean" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" }, "/wp/v2/wp_pattern_category": { @@ -76390,7 +99003,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -76426,14 +99043,26 @@ "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"], + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], "required": false, "type": "string" }, @@ -76472,7 +99101,9 @@ "type": "array" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -76501,13 +99132,18 @@ "type": "string" } }, - "methods": ["POST"] + "methods": [ + "POST" + ] } ], - "methods": ["GET", "POST"], + "methods": [ + "GET", + "POST" + ], "namespace": "wp/v2" }, - "/wp/v2/wp_pattern_category/(?P\u003Cid\u003E[\\d]+)": { + "/wp/v2/wp_pattern_category/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { @@ -76517,7 +99153,11 @@ "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "enum": ["view", "embed", "edit"], + "enum": [ + "edit", + "embed", + "view" + ], "required": false, "type": "string" }, @@ -76527,7 +99167,9 @@ "type": "integer" } }, - "methods": ["GET"] + "methods": [ + "GET" + ] }, { "allow_batch": { @@ -76561,7 +99203,11 @@ "type": "string" } }, - "methods": ["POST", "PUT", "PATCH"] + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { "allow_batch": { @@ -76580,10 +99226,18 @@ "type": "integer" } }, - "methods": ["DELETE"] + "methods": [ + "DELETE" + ] } ], - "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], "namespace": "wp/v2" } }, diff --git a/mago-schema.json b/mago-schema.json index 88432f04..a4a12e52 100644 --- a/mago-schema.json +++ b/mago-schema.json @@ -17,7 +17,10 @@ "baseline": { "default": null, "description": "Path to a baseline file to ignore listed issues.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "baseline-variant": { "$ref": "#/$defs/BaselineVariant", @@ -135,7 +138,10 @@ }, "perform-heuristic-checks": { "description": "**Deprecated**: Use `check-missing-override` and `find-unused-parameters` instead.\n\nWhen set to `true`, enables both `check-missing-override` and `find-unused-parameters`.\nWhen set to `false`, disables both.\n\nThis option is kept for backwards compatibility with existing configurations.", - "type": ["boolean", "null"], + "type": [ + "boolean", + "null" + ], "writeOnly": true }, "performance": { @@ -200,11 +206,18 @@ "type": "object" }, "ArrayStyleOption": { - "enum": ["short", "long"], + "enum": [ + "long", + "short" + ], "type": "string" }, "AssertionStyle": { - "enum": ["static", "self_", "this"], + "enum": [ + "self_", + "static", + "this" + ], "type": "string" }, "BaselineVariant": { @@ -224,7 +237,11 @@ }, "BraceStyle": { "description": "Specifies brace placement style for various constructs.\n\n- `SameLine`: Opening brace on the same line as the declaration\n- `NextLine`: Opening brace on the next line for single-line signatures;\n on the same line when the signature breaks across multiple lines\n- `AlwaysNextLine`: Opening brace always on the next line, regardless of\n whether the signature breaks", - "enum": ["same_line", "next_line", "always_next_line"], + "enum": [ + "always_next_line", + "next_line", + "same_line" + ], "type": "string" }, "DisallowedEntry": { @@ -237,13 +254,18 @@ "description": "Entry with name and optional help message.", "properties": { "help": { - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "name": { "type": "string" } }, - "required": ["name"], + "required": [ + "name" + ], "type": "object" } ], @@ -251,7 +273,12 @@ }, "EndOfLine": { "description": "Specifies the style of line endings.", - "enum": ["auto", "lf", "crlf", "cr"], + "enum": [ + "auto", + "cr", + "crlf", + "lf" + ], "type": "string" }, "FormatterConfiguration": { @@ -735,7 +762,10 @@ "baseline": { "default": null, "description": "Path to a baseline file to ignore listed issues.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "baseline-variant": { "$ref": "#/$defs/BaselineVariant", @@ -815,7 +845,10 @@ "type": "array" } }, - "required": ["code", "in"], + "required": [ + "code", + "in" + ], "type": "object" } ], @@ -852,7 +885,10 @@ "baseline": { "default": null, "description": "Path to a baseline file to ignore listed issues.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "baseline-variant": { "$ref": "#/$defs/BaselineVariant", @@ -994,11 +1030,11 @@ "level": "Help" }, "halstead": { - "difficulty-threshold": 12.0, - "effort-threshold": 5000.0, + "difficulty-threshold": 12, + "effort-threshold": 5000, "enabled": true, "level": "Warning", - "volume-threshold": 1000.0 + "volume-threshold": 1000 }, "identity-comparison": { "enabled": true, @@ -1514,7 +1550,9 @@ }, "tainted-data-to-sink": { "enabled": true, - "known-sink-functions": ["printf"], + "known-sink-functions": [ + "printf" + ], "level": "Error" }, "too-many-enum-cases": { @@ -1585,12 +1623,19 @@ "type": "object" }, "MethodChainBreakingStyle": { - "enum": ["same_line", "next_line"], + "enum": [ + "next_line", + "same_line" + ], "type": "string" }, "NullTypeHint": { "description": "Specifies null type hint style.", - "enum": ["null_pipe", "null_pipe_last", "question"], + "enum": [ + "null_pipe", + "null_pipe_last", + "question" + ], "type": "string" }, "PHPVersion": { @@ -1697,7 +1742,10 @@ "type": "array" } }, - "required": ["namespace", "permit"], + "required": [ + "namespace", + "permit" + ], "type": "object" }, "PerimeterSettings": { @@ -1747,14 +1795,22 @@ "$ref": "#/$defs/Path" } }, - "required": ["path", "kinds"], + "required": [ + "kinds", + "path" + ], "type": "object" } ] }, "PermittedDependencyKind": { "description": "Represents the specific types of symbols allowed from a path.", - "enum": ["class-like", "function", "constant", "attribute"], + "enum": [ + "attribute", + "class-like", + "constant", + "function" + ], "type": "string" }, "RuleSettings": { @@ -2654,7 +2710,9 @@ "type": "array" }, "known-sink-functions": { - "default": ["printf"], + "default": [ + "printf" + ], "items": { "type": "string" }, @@ -2758,7 +2816,10 @@ "description": "Maximum cyclomatic complexity allowed for a single method.\n\nWhen set, each method in a class-like is checked individually against this threshold,\nin addition to the class-level `threshold` check.\n\nDefault: `None` (methods are only checked as part of the class-level total).", "format": "uint", "minimum": 0, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "threshold": { "default": 15, @@ -3308,7 +3369,10 @@ "description": "Maximum nesting depth allowed inside a single function, method, closure, or arrow function.\n\nWhen set, each function-like body is checked independently against this threshold,\nwith nesting counted from the function body (not the file root).\n\nDefault: `None` (function-like bodies are only checked against the global `threshold`).", "format": "uint", "minimum": 0, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "level": { "$ref": "#/$defs/Level", @@ -3331,7 +3395,10 @@ "format": "uint8", "maximum": 255, "minimum": 0, - "type": ["integer", "null"] + "type": [ + "integer", + "null" + ] }, "enabled": { "default": true, @@ -3401,12 +3468,12 @@ "additionalProperties": false, "properties": { "difficulty-threshold": { - "default": 12.0, + "default": 12, "format": "double", "type": "number" }, "effort-threshold": { - "default": 5000.0, + "default": 5000, "format": "double", "type": "number" }, @@ -3425,7 +3492,7 @@ "default": "Warning" }, "volume-threshold": { - "default": 1000.0, + "default": 1000, "format": "double", "type": "number" } @@ -5417,11 +5484,11 @@ "halstead": { "$ref": "#/$defs/RuleSettings20", "default": { - "difficulty-threshold": 12.0, - "effort-threshold": 5000.0, + "difficulty-threshold": 12, + "effort-threshold": 5000, "enabled": true, "level": "Warning", - "volume-threshold": 1000.0 + "volume-threshold": 1000 } }, "identity-comparison": { @@ -6303,7 +6370,9 @@ "$ref": "#/$defs/RuleSettings136", "default": { "enabled": true, - "known-sink-functions": ["printf"], + "known-sink-functions": [ + "printf" + ], "level": "Error" } }, @@ -6423,7 +6492,9 @@ "type": "array" }, "extensions": { - "default": ["php"], + "default": [ + "php" + ], "description": "File extensions to filter by.\n\nDefaults to `[\".php\"]`.", "items": { "type": "string" @@ -6461,7 +6532,9 @@ "type": "string" } }, - "required": ["workspace"], + "required": [ + "workspace" + ], "type": "object" }, "StructuralInheritanceConstraint": { @@ -6504,27 +6577,42 @@ "items": { "$ref": "#/$defs/StructuralSymbolKind" }, - "type": ["array", "null"] + "type": [ + "array", + "null" + ] }, "must-be-abstract": { "default": null, "description": "If true, the symbol must be declared `abstract`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "must-be-final": { "default": null, "description": "If true, the symbol must be declared `final`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "must-be-named": { "default": null, "description": "Optional naming pattern the symbol's name must match.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "must-be-readonly": { "default": null, "description": "If true, the symbol must be declared `readonly`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "must-extend": { "anyOf": [ @@ -6577,7 +6665,10 @@ "not-on": { "default": null, "description": "An optional exclusion pattern; if the namespace matches this, the rule is skipped.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "on": { "default": "", @@ -6587,7 +6678,10 @@ "reason": { "default": null, "description": "A human-readable reason for this rule.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "target": { "anyOf": [ @@ -6619,7 +6713,15 @@ "type": "object" }, "StructuralSymbolKind": { - "enum": ["class-like", "class", "interface", "trait", "enum", "constant", "function"], + "enum": [ + "class", + "class-like", + "constant", + "enum", + "function", + "interface", + "trait" + ], "type": "string" } }, @@ -6682,7 +6784,10 @@ "editor-url": { "default": null, "description": "Editor URL template for OSC 8 terminal hyperlinks on file paths in diagnostics.\n\nWhen set, file paths in diagnostic output become clickable links in terminals\nthat support OSC 8 hyperlinks (e.g., iTerm2, Wezterm, Kitty, Windows Terminal).\n\nSupported placeholders:\n- `%file%` — absolute file path\n- `%line%` — line number\n- `%column%` — column number\n\nCan be set via `MAGO_EDITOR_URL` environment variable or `editor-url` in `mago.toml`.", - "type": ["string", "null"] + "type": [ + "null", + "string" + ] }, "formatter": { "$ref": "#/$defs/FormatterConfiguration", @@ -6830,11 +6935,11 @@ "level": "Help" }, "halstead": { - "difficulty-threshold": 12.0, - "effort-threshold": 5000.0, + "difficulty-threshold": 12, + "effort-threshold": 5000, "enabled": true, "level": "Warning", - "volume-threshold": 1000.0 + "volume-threshold": 1000 }, "identity-comparison": { "enabled": true, @@ -7350,7 +7455,9 @@ }, "tainted-data-to-sink": { "enabled": true, - "known-sink-functions": ["printf"], + "known-sink-functions": [ + "printf" + ], "level": "Error" }, "too-many-enum-cases": { @@ -7434,7 +7541,9 @@ "$ref": "#/$defs/SourceConfiguration", "default": { "excludes": [], - "extensions": ["php"], + "extensions": [ + "php" + ], "glob": { "backslash-escape": true, "case-insensitive": false, diff --git a/mago.toml b/mago.toml index 00601123..bdcdd94f 100644 --- a/mago.toml +++ b/mago.toml @@ -5,7 +5,9 @@ stack-size = 0 threads = 0 [source] - excludes = ["web/wp/wp-admin/includes/noop.php"] + excludes = [ + "web/wp/wp-admin/includes/noop.php", + ] extensions = ["php"] includes = ["config", "vendor", "web/app/plugins", "web/vendor", "web/wp"] paths = ["web/app/themes/haiku-atelier-2024"] @@ -66,3 +68,9 @@ threads = 0 negation-complexity-threshold = 8192 saturation-complexity-threshold = 16384 string-combination-threshold = 256 + +[formatter] + excludes = [ + "web/app/mu-plugins", + "web/app/plugins", + ] diff --git a/package.json b/package.json index a418a8dc..721ec17d 100755 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "valibot": "1.1.0" }, "devDependencies": { - "@effect/language-service": "^0.84.3", + "@effect/language-service": "^0.85.0", "@gcch/configuration-eslint": "git+https://git.gcch.fr/gcch/configuration-eslint#62ee424274", "@gcch/configuration-oxlint": "git+https://git.gcch.fr/gcch/configuration-oxlint#0968f683", "@gcch/configuration-prettier": "git+https://git.gcch.fr/gcch/configuration-prettier#8de937e801", @@ -60,7 +60,7 @@ "stylelint-plugin-logical-css": "^2.1.0", "typescript": "6.0.2", "typescript-eslint": "^8.58.1", - "vite": "^8.0.7", + "vite": "^8.0.8", "vite-tsconfig-paths": "^6.1.1" }, "browserslist": [ diff --git a/phpactor.schema.json b/phpactor.schema.json index dc35600f..309f3c4c 100644 --- a/phpactor.schema.json +++ b/phpactor.schema.json @@ -1,12 +1,12 @@ { - "$schema": "https:\/\/json-schema.org\/draft-07\/schema", + "$schema": "https://json-schema.org/draft-07/schema", "properties": { "$schema": { "default": "", "description": "Path to JSON schema, which can be used for config autocompletion, use phpactor config:initialize to update" }, "behat.config_path": { - "default": "%project_root%\/behat.yml", + "default": "%project_root%/behat.yml", "description": "Path to the main behat.yml (including the filename behat.yml)" }, "behat.symfony.di_xml_path": { @@ -61,11 +61,19 @@ "description": "Object fill refactoring: use named parameters" }, "code_transform.template_paths": { - "default": ["%project_config%\/templates", "%config%\/templates"], + "default": [ + "%config%/templates", + "%project_config%/templates" + ], "description": "Paths in which to look for code templates" }, - "command": { "description": "Internal use only - name of the command which was executed" }, - "completion.dedupe": { "default": true, "description": "If results should be de-duplicated" }, + "command": { + "description": "Internal use only - name of the command which was executed" + }, + "completion.dedupe": { + "default": true, + "description": "If results should be de-duplicated" + }, "completion.dedupe_match_fqn": { "default": true, "description": "If ``completion.dedupe``, consider the class FQN in addition to the completion suggestion" @@ -73,9 +81,14 @@ "completion.label_formatter": { "default": "helpful", "description": "Definition of how to format entries in the completion list", - "enum": ["helpful", "fqn"] + "enum": [ + "fqn", + "helpful" + ] + }, + "completion.limit": { + "description": "Sets a limit on the number of completion suggestions for any request" }, - "completion.limit": { "description": "Sets a limit on the number of completion suggestions for any request" }, "completion_worse.completor.attribute.enabled": { "default": true, "description": "Enable or disable the ``attribute`` completor.\n\nCompletion for attribute class names." @@ -92,7 +105,10 @@ "default": true, "description": "Enable or disable the ``class_member`` completor.\n\nCompletion for class members." }, - "completion_worse.completor.constant.enabled": { "default": false, "description": null }, + "completion_worse.completor.constant.enabled": { + "default": false, + "description": null + }, "completion_worse.completor.constructor.enabled": { "default": true, "description": "Enable or disable the ``constructor`` completor.\n\nCompletion for constructors." @@ -147,7 +163,7 @@ }, "completion_worse.completor.symfony.enabled": { "default": true, - "description": "Enable\/disable the Symfony completor - depends on Symfony extension being enabled" + "description": "Enable/disable the Symfony completor - depends on Symfony extension being enabled" }, "completion_worse.completor.type.enabled": { "default": true, @@ -161,19 +177,28 @@ "default": true, "description": "Enable or disable the ``worse_parameter`` completor.\n\nCompletion for method or function parameters." }, - "completion_worse.debug": { "default": false, "description": "Include debug info in completion results" }, - "completion_worse.experimantal": { "default": false, "description": "Enable experimental functionality" }, + "completion_worse.debug": { + "default": false, + "description": "Include debug info in completion results" + }, + "completion_worse.experimantal": { + "default": false, + "description": "Enable experimental functionality" + }, "completion_worse.name_completion_priority": { "default": "proximity", "description": "Strategy to use when ordering completion results for classes and functions:\n\n- `proximity`: Classes and functions will be ordered by their proximity to the text document being edited.\n- `none`: No ordering will be applied." }, - "completion_worse.snippets": { "default": true, "description": "Enable or disable completion snippets" }, + "completion_worse.snippets": { + "default": true, + "description": "Enable or disable completion snippets" + }, "composer.autoload_deregister": { "default": true, "description": "Immediately de-register the autoloader once it has been included (prevent conflicts with Phpactor's autoloader). Some platforms may require this to be disabled" }, "composer.autoloader_path": { - "default": "%project_root%\/vendor\/autoload.php", + "default": "%project_root%/vendor/autoload.php", "description": "Path to project's autoloader, can be an array" }, "composer.class_maps_only": { @@ -186,9 +211,23 @@ }, "console.decorated": { "description": "Whether to decorate messages (null for auto-guessing)", - "enum": [true, false, null] + "enum": [ + true, + false, + null + ] + }, + "console.verbosity": { + "default": 32, + "description": "Verbosity level", + "enum": [ + 16, + 32, + 64, + 128, + 256 + ] }, - "console.verbosity": { "default": 32, "description": "Verbosity level", "enum": [16, 32, 64, 128, 256] }, "console_dumper_default": { "default": "indented", "description": "Name of the \"dumper\" (renderer) to use for some CLI commands" @@ -197,75 +236,131 @@ "default": 1610612736, "description": "Ensure that PHP has a memory_limit of at least this amount in bytes" }, - "file_path_resolver.app_name": { "default": "phpactor", "description": null }, - "file_path_resolver.application_root": { "description": null }, - "file_path_resolver.enable_cache": { "default": true, "description": null }, - "file_path_resolver.enable_logging": { "default": true, "description": null }, - "file_path_resolver.project_root": { "default": "\/opt\/phpactor", "description": null }, + "file_path_resolver.app_name": { + "default": "phpactor", + "description": null + }, + "file_path_resolver.application_root": { + "description": null + }, + "file_path_resolver.enable_cache": { + "default": true, + "description": null + }, + "file_path_resolver.enable_logging": { + "default": true, + "description": null + }, + "file_path_resolver.project_root": { + "default": "/opt/phpactor", + "description": null + }, "indexer.buffer_time": { "default": 500, "description": "For real-time indexers only: the time, in milliseconds, to buffer the results", - "type": ["integer"] + "type": [ + "integer" + ] }, "indexer.enabled_watchers": { - "default": ["inotify", "watchman", "find", "php"], + "default": [ + "find", + "inotify", + "php", + "watchman" + ], "description": "List of allowed watchers. The first watcher that supports the current system will be used", - "type": ["object"] + "type": [ + "object" + ] }, "indexer.exclude_patterns": { - "default": ["\/vendor\/**\/Tests\/**\/*", "\/vendor\/**\/tests\/**\/*", "\/vendor\/composer\/**\/*"], + "default": [ + "/vendor/**/tests/**/*", + "/vendor/**/Tests/**/*", + "/vendor/composer/**/*" + ], "description": "Glob patterns to exclude while indexing", - "type": ["object"] + "type": [ + "object" + ] }, "indexer.follow_symlinks": { "default": false, "description": "To allow indexer to follow symlinks", - "type": ["boolean"] + "type": [ + "boolean" + ] }, "indexer.implementation_finder.deep": { "default": true, "description": "Recurse over class implementations to resolve all class implementations (not just the classes directly implementing the subject)", - "type": ["boolean"] + "type": [ + "boolean" + ] }, "indexer.include_patterns": { - "default": ["\/**\/*.php", "\/**\/*.phar"], + "default": [ + "/**/*.phar", + "/**/*.php" + ], "description": "Glob patterns to include while indexing", - "type": ["object"] + "type": [ + "object" + ] }, "indexer.index_path": { - "default": "%cache%\/index\/%project_id%", + "default": "%cache%/index/%project_id%", "description": "Path where the index should be saved", - "type": ["string"] + "type": [ + "string" + ] }, "indexer.poll_time": { "default": 5000, "description": "For polling indexers only: the time, in milliseconds, between polls (e.g. filesystem scans)", - "type": ["integer"] + "type": [ + "integer" + ] }, "indexer.project_root": { "default": "%project_root%", "description": "The root path to use for scanning the index", - "type": ["string"] + "type": [ + "string" + ] }, "indexer.reference_finder.deep": { "default": true, "description": "Recurse over class implementations to resolve all references", - "type": ["boolean"] + "type": [ + "boolean" + ] }, "indexer.stub_paths": { "default": [], "description": "Paths to external folders to index. They will be indexed only once, if you want to take any changes into account you will have to reindex your project manually.", - "type": ["object"] + "type": [ + "object" + ] }, "indexer.supported_extensions": { - "default": ["php", "phar"], + "default": [ + "phar", + "php" + ], "description": "File extensions (e.g. `php`) for files that should be indexed", - "type": ["object"] + "type": [ + "object" + ] + }, + "language_server.catch_errors": { + "default": true, + "description": null }, - "language_server.catch_errors": { "default": true, "description": null }, "language_server.diagnostic_exclude_paths": { "default": [], - "description": "List of paths to exclude from diagnostics, e.g. `vendor\/**\/*`" + "description": "List of paths to exclude from diagnostics, e.g. `vendor/**/*`" }, "language_server.diagnostic_outsource": { "default": true, @@ -296,19 +391,30 @@ }, "language_server.enable_workspace": { "default": true, - "description": "If workspace management \/ text synchronization should be enabled (this isn't required for some language server implementations, e.g. static analyzers)" + "description": "If workspace management / text synchronization should be enabled (this isn't required for some language server implementations, e.g. static analyzers)" + }, + "language_server.file_event_globs": { + "default": [ + "**/*.php" + ], + "description": null + }, + "language_server.file_events": { + "default": true, + "description": "Register to receive file events" }, - "language_server.file_event_globs": { "default": ["**\/*.php"], "description": null }, - "language_server.file_events": { "default": true, "description": "Register to receive file events" }, "language_server.method_alias_map": { "default": [], "description": "Allow method names to be re-mapped. Useful for maintaining backwards compatibility" }, "language_server.phpactor_bin": { - "default": "\/opt\/phpactor\/lib\/Extension\/LanguageServer\/..\/..\/..\/bin\/phpactor", + "default": "/opt/phpactor/lib/Extension/LanguageServer/../../../bin/phpactor", "description": "Internal use only - name path to Phpactor binary" }, - "language_server.profile": { "default": false, "description": "Logs timing information for incoming LSP requests" }, + "language_server.profile": { + "default": false, + "description": "Logs timing information for incoming LSP requests" + }, "language_server.self_destruct_timeout": { "default": 2500, "description": "Wait this amount of time (in milliseconds) after a shutdown request before self-destructing" @@ -340,22 +446,30 @@ "language_server_configuration.auto_config": { "default": true, "description": "Prompt to enable extensions which apply to your project on language server start", - "type": ["boolean"] + "type": [ + "boolean" + ] }, "language_server_indexer.reindex_timeout": { "default": 300, "description": "Unconditionally reindex modified files every N seconds" }, - "language_server_indexer.workspace_symbol_search_limit": { "default": 250, "description": null }, + "language_server_indexer.workspace_symbol_search_limit": { + "default": 250, + "description": null + }, "language_server_php_cs_fixer.bin": { - "default": "%project_root%\/vendor\/bin\/php-cs-fixer", + "default": "%project_root%/vendor/bin/php-cs-fixer", "description": "Path to the php-cs-fixer executable" }, "language_server_php_cs_fixer.config": { - "description": "Set custom PHP CS config path. Ex., %project_root%\/.php-cs-fixer.php" + "description": "Set custom PHP CS config path. Ex., %project_root%/.php-cs-fixer.php" }, "language_server_php_cs_fixer.env": { - "default": { "PHP_CS_FIXER_IGNORE_ENV": true, "XDEBUG_MODE": "off" }, + "default": { + "PHP_CS_FIXER_IGNORE_ENV": true, + "XDEBUG_MODE": "off" + }, "description": "Environment for PHP CS Fixer (e.g. to set PHP_CS_FIXER_IGNORE_ENV)" }, "language_server_php_cs_fixer.show_diagnostics": { @@ -363,16 +477,24 @@ "description": "Whether PHP CS Fixer diagnostics are shown" }, "language_server_phpstan.bin": { - "default": "%project_root%\/vendor\/bin\/phpstan", + "default": "%project_root%/vendor/bin/phpstan", "description": "Path to the PHPStan executable" }, - "language_server_phpstan.config": { "description": "Override the PHPStan configuration file" }, - "language_server_phpstan.level": { "description": "Override the PHPStan level" }, - "language_server_phpstan.mem_limit": { "description": "Override the PHPStan memory limit" }, + "language_server_phpstan.config": { + "description": "Override the PHPStan configuration file" + }, + "language_server_phpstan.level": { + "description": "Override the PHPStan level" + }, + "language_server_phpstan.mem_limit": { + "description": "Override the PHPStan memory limit" + }, "language_server_psalm.bin": { - "default": "%project_root%\/vendor\/bin\/psalm", - "description": "Path to psalm if different from vendor\/bin\/psalm", - "type": ["string"] + "default": "%project_root%/vendor/bin/psalm", + "description": "Path to psalm if different from vendor/bin/psalm", + "type": [ + "string" + ] }, "language_server_psalm.error_level": { "description": "Override level at which Psalm should report errors (lower => more errors)" @@ -380,28 +502,39 @@ "language_server_psalm.show_info": { "default": true, "description": "If infos from psalm should be displayed", - "type": ["boolean"] + "type": [ + "boolean" + ] }, "language_server_psalm.threads": { "default": 1, "description": "Set the number of threads Psalm should use. Warning: NULL will use as many as possible and may crash your computer", - "type": ["integer"] + "type": [ + "integer" + ] }, "language_server_psalm.timeout": { "default": 15, "description": "Kill the psalm process after this number of seconds", - "type": ["integer"] + "type": [ + "integer" + ] }, "language_server_psalm.use_cache": { "default": true, "description": "If the Psalm cache should be used (see the `--no-cache` option)", - "type": ["boolean"] + "type": [ + "boolean" + ] }, "language_server_reference_reference_finder.reference_timeout": { "default": 60, "description": "Stop searching for references after this time (in seconds) has expired" }, - "language_server_worse_reflection.diagnostics.enable": { "default": true, "description": "Enable diagnostics" }, + "language_server_worse_reflection.diagnostics.enable": { + "default": true, + "description": "Enable diagnostics" + }, "language_server_worse_reflection.inlay_hints.enable": { "default": false, "description": "Enable inlay hints (experimental)" @@ -418,34 +551,87 @@ "default": 100, "description": "Minimum interval to update the workspace index as documents are updated (in milliseconds)" }, - "logger.name": { "default": "logger", "description": null, "type": ["string"] }, - "logging.enabled": { "default": false, "description": null, "type": ["boolean"] }, - "logging.fingers_crossed": { "default": false, "description": null, "type": ["boolean"] }, - "logging.formatter": { "description": null }, + "logger.name": { + "default": "logger", + "description": null, + "type": [ + "string" + ] + }, + "logging.enabled": { + "default": false, + "description": null, + "type": [ + "boolean" + ] + }, + "logging.fingers_crossed": { + "default": false, + "description": null, + "type": [ + "boolean" + ] + }, + "logging.formatter": { + "description": null + }, "logging.level": { "default": "warning", "description": null, - "enum": ["emergency", "alert", "critical", "error", "warning", "notice", "info", "debug"], - "type": ["string"] + "enum": [ + "alert", + "critical", + "debug", + "emergency", + "error", + "info", + "notice", + "warning" + ], + "type": [ + "string" + ] + }, + "logging.path": { + "default": "application.log", + "description": null, + "type": [ + "string" + ] + }, + "navigator.autocreate": { + "default": [], + "description": null + }, + "navigator.destinations": { + "default": [], + "description": null }, - "logging.path": { "default": "application.log", "description": null, "type": ["string"] }, - "navigator.autocreate": { "default": [], "description": null }, - "navigator.destinations": { "default": [], "description": null }, "object_renderer.template_paths.markdown": { - "default": ["%project_config%\/templates\/markdown", "%config%\/templates\/markdown"], + "default": [ + "%config%/templates/markdown", + "%project_config%/templates/markdown" + ], "description": "Paths in which to look for templates for hover information." }, "php.version": { "description": "Consider this value to be the project\\'s version of PHP (e.g. `7.4`). If omitted\nit will check `composer.json` (by the configured platform then the PHP requirement) before\nfalling back to the PHP version of the current process." }, - "php_code_sniffer.args": { "default": [], "description": "Additional arguments to pass to the PHPCS process" }, + "php_code_sniffer.args": { + "default": [], + "description": "Additional arguments to pass to the PHPCS process" + }, "php_code_sniffer.bin": { - "default": "%project_root%\/vendor\/bin\/phpcs", + "default": "%project_root%/vendor/bin/phpcs", "description": "Path to the phpcs executable" }, - "php_code_sniffer.cwd": { "description": "Working directory for PHPCS" }, + "php_code_sniffer.cwd": { + "description": "Working directory for PHPCS" + }, "php_code_sniffer.env": { - "default": { "XDEBUG_MODE": "off" }, + "default": { + "XDEBUG_MODE": "off" + }, "description": "Environment for PHP_CodeSniffer (e.g. to set XDEBUG_MODE)" }, "php_code_sniffer.show_diagnostics": { @@ -456,15 +642,24 @@ "default": false, "description": "Only consider public services when providing analysis for the service locator" }, - "rpc.replay_path": { "default": "%cache%\/replay.json", "description": "Path where the replays should be stored" }, - "rpc.store_replay": { "default": false, "description": "Should replays be stored?" }, - "source_code_filesystem.project_root": { "default": "%project_root%", "description": null }, + "rpc.replay_path": { + "default": "%cache%/replay.json", + "description": "Path where the replays should be stored" + }, + "rpc.store_replay": { + "default": false, + "description": "Should replays be stored?" + }, + "source_code_filesystem.project_root": { + "default": "%project_root%", + "description": null + }, "symfony.xml_path": { - "default": "%project_root%\/var\/cache\/dev\/App_KernelDevDebugContainer.xml", + "default": "%project_root%/var/cache/dev/App_KernelDevDebugContainer.xml", "description": "Path to the Symfony container XML dump file" }, "worse_reflection.cache_dir": { - "default": "%cache%\/worse-reflection", + "default": "%cache%/worse-reflection", "description": "Cache directory for stubs" }, "worse_reflection.cache_lifetime": { @@ -474,18 +669,26 @@ "worse_reflection.diagnostics.undefined_variable.suggestion_levenshtein_disatance": { "default": 4, "description": "Levenshtein distance to use when suggesting corrections for variable names", - "type": ["integer"] + "type": [ + "integer" + ] + }, + "worse_reflection.enable_cache": { + "default": true, + "description": "If reflection caching should be enabled" }, - "worse_reflection.enable_cache": { "default": true, "description": "If reflection caching should be enabled" }, "worse_reflection.enable_context_location": { "default": true, "description": "If source code is passed to a ``Reflector`` then temporarily make it available as a\nsource location. Note this should NOT be enabled if the source code can be\nlocated in another (e.g. when running a Language Server)" }, "worse_reflection.stub_dir": { - "default": "%application_root%\/vendor\/jetbrains\/phpstorm-stubs", + "default": "%application_root%/vendor/jetbrains/phpstorm-stubs", "description": "Location of the core PHP stubs - these will be scanned and cached on the first request" }, - "xdebug_disable": { "default": true, "description": "If XDebug should be automatically disabled" } + "xdebug_disable": { + "default": true, + "description": "If XDebug should be automatically disabled" + } }, "title": "Phpactor Configuration Schema", "type": "object" diff --git a/scripts/importe-dernier-export-bdd.ts b/scripts/importe-dernier-export-bdd.ts index fa8435c6..85a889ee 100644 --- a/scripts/importe-dernier-export-bdd.ts +++ b/scripts/importe-dernier-export-bdd.ts @@ -1,13 +1,14 @@ import { $ } from "bun"; -import { Array, Console, Effect, Layer, ManagedRuntime, Option, Order, pipe, Schema, ServiceMap } from "effect"; -import { UnknownError } from "effect/Cause"; +import type { Option } from "effect"; +import { Array as FxArray, Console, Effect, Layer, ManagedRuntime, Order, pipe, Schema, ServiceMap } from "effect"; +import type { UnknownError } from "effect/Cause"; import { readdir } from "node:fs/promises"; class PodmanError extends Schema.TaggedErrorClass()("PodmanError", { cause: Schema.Error, }) {} -class FileSystemError extends Schema.TaggedErrorClass()("FileSystemError", { +class FSError extends Schema.TaggedErrorClass()("FSError", { cause: Schema.Error, }) {} @@ -21,21 +22,21 @@ class Podman extends ServiceMap.Service< static readonly layer = Layer.effect( Podman, // oxlint-disable-next-line require-yield - Effect.gen(function* () { - const launchContainers = Effect.fn("launchContainers")(function* () { + Effect.gen(function*() { + const launchContainers = Effect.fn("launchContainers")(function*() { return yield* pipe( - Effect.tryPromise(() => $`podman compose up -d &> /dev/null`), + Effect.tryPromise(async () => $`podman compose up -d &> /dev/null`), Effect.map((shell: $.ShellOutput) => shell.text()), Effect.mapError((error: UnknownError) => new PodmanError({ cause: error })), ); }); - const importLatestDbInWordPressContainer = Effect.fn("importLatestDbInWordPressContainer")(function* ( + const importLatestDbInWordPressContainer = Effect.fn("importLatestDbInWordPressContainer")(function*( exportPath: string, ) { return yield* pipe( Effect.tryPromise( - () => + async () => $`podman exec -it haikuatelier.fr-wordpress fish -c "cd web && wp --allow-root db import ${exportPath} > /dev/null"`, ), Effect.map((shell: $.ShellOutput) => shell.text()), @@ -51,47 +52,44 @@ class Podman extends ServiceMap.Service< ); } -class FileSystem extends ServiceMap.Service< - FileSystem, +class FS extends ServiceMap.Service< + FS, { - getLatestDbExport(): Effect.Effect; + getLatestDbExport(): Effect.Effect; } ->()("haikuatelier.fr/scripts/importe-dernier-export-bdd/FileSystem") { +>()("haikuatelier.fr/scripts/importe-dernier-export-bdd/FS") { static readonly layer = Layer.effect( - FileSystem, + FS, // oxlint-disable-next-line require-yield - Effect.gen(function* () { - const getLatestDbExport = Effect.fn("getLatestDbExport")(function* () { + Effect.gen(function*() { + const getLatestDbExport = Effect.fn("getLatestDbExport")(function*() { return yield* pipe( - Effect.tryPromise(() => readdir(`./db`)), - Effect.map((paths: ReadonlyArray) => Array.sort(paths, Order.String)), - Effect.map((sortedPaths: ReadonlyArray) => Array.last(sortedPaths)), + Effect.tryPromise(async () => readdir(`./db`)), + Effect.map((paths: ReadonlyArray) => FxArray.sort(paths, Order.String)), + Effect.map((sortedPaths: ReadonlyArray) => FxArray.last(sortedPaths)), Effect.flatMap((path: Option.Option) => Effect.fromOption(path)), - Effect.mapError((_) => new FileSystemError({ cause: new Error("Aucun export de BDD n'est disponible.") })), + Effect.mapError(_ => new FSError({ cause: new Error("Aucun export de BDD n'est disponible.") })), ); }); - return FileSystem.of({ + return FS.of({ getLatestDbExport, }); }), ); } -const mainLayer = Layer.mergeAll(Podman.layer, FileSystem.layer); +const mainLayer = Layer.mergeAll(Podman.layer, FS.layer); const runtime = ManagedRuntime.make(mainLayer); -const program = Effect.fn("program")(function* () { - yield* Podman.use((podman) => podman.launchContainers()); +const program = Effect.fn("program")(function*() { + yield* Podman.use(podman => podman.launchContainers()); yield* Console.log("Containers are launched."); - const latestExportPath: string = pipe( - yield* FileSystem.use((fs) => fs.getLatestDbExport()), - (path) => `../db/${path}`, - ); + const latestExportPath: string = pipe(yield* FS.use(fs => fs.getLatestDbExport()), path => `../db/${path}`); yield* Console.log(latestExportPath); - yield* Podman.use((podman) => podman.importLatestDbInWordPressContainer(latestExportPath)); + yield* Podman.use(podman => podman.importLatestDbInWordPressContainer(latestExportPath)); yield* Console.log("Import done."); }); diff --git a/scripts/pull-container-images.ts b/scripts/pull-container-images.ts index d10556ee..107461b2 100644 --- a/scripts/pull-container-images.ts +++ b/scripts/pull-container-images.ts @@ -1,5 +1,5 @@ import { YAML } from "bun"; -import { Console, Data, Effect, Array as EffectArray, pipe, Record, Schema, SchemaIssue } from "effect"; +import { Array as EffectArray, Console, Data, Effect, pipe, Record, Schema, SchemaIssue } from "effect"; import { SchemaError } from "effect/Schema"; const COMPOSE_PATH = "compose.yaml"; @@ -21,7 +21,7 @@ class ScriptError extends Data.TaggedError("ScriptError")<{ cause: unknown }> {} * @param compose Le fichier _Compose_ sous forme d'objet. * @returns Les noms des Services sous forme de tableau. */ -const getServicesFromComposeYaml: (compose: Compose) => ReadonlyArray = (compose) => +const getServicesFromComposeYaml: (compose: Compose) => ReadonlyArray = compose => Record.keys(compose.services); /** @@ -31,7 +31,7 @@ const getServicesFromComposeYaml: (compose: Compose) => ReadonlyArray = * @returns Le contenu textuel du fichier sous forme de chaîne de caractères. */ const getFileContent: (filePath: string) => Effect.Effect = Effect.fn("getFileContent")( - function* (filePath) { + function*(filePath) { const fileRef: Bun.BunFile = Bun.file(filePath); yield* Effect.tryPromise({ @@ -56,12 +56,12 @@ const getFileContent: (filePath: string) => Effect.Effect = const getComposeYaml: ( path: string, schema: Schema.Schema, -) => Effect.Effect = Effect.fn("getComposeYaml")(function* (path, schema) { +) => Effect.Effect = Effect.fn("getComposeYaml")(function*(path, schema) { return yield* pipe( getFileContent(path), Effect.map((text: string): unknown => YAML.parse(text)), Effect.flatMap((yaml: unknown) => - Schema.decodeUnknownEffect(schema)(yaml, { errors: "all", onExcessProperty: "ignore" }), + Schema.decodeUnknownEffect(schema)(yaml, { errors: "all", onExcessProperty: "ignore" }) ), Effect.mapError((error): ScriptError => { if (error instanceof SchemaError) { @@ -76,7 +76,7 @@ const getComposeYaml: ( const program: Effect.Effect, ScriptError> = pipe( getComposeYaml(COMPOSE_PATH, Compose), Effect.map((compose: Compose) => getServicesFromComposeYaml(compose)), - Effect.map((keys: ReadonlyArray) => EffectArray.filter(keys, (key) => key !== "wordpress")), + Effect.map((keys: ReadonlyArray) => EffectArray.filter(keys, key => key !== "wordpress")), Effect.orElseSucceed(() => [""]), Effect.tap((services: ReadonlyArray) => { Bun.spawn({ cmd: ["podman", "compose", "pull", ...services], timeout: DEFAULT_CMD_TIMEOUT }); diff --git a/scripts/remove-scaled-images.php b/scripts/remove-scaled-images.php index d4bd6024..ac57fe94 100755 --- a/scripts/remove-scaled-images.php +++ b/scripts/remove-scaled-images.php @@ -14,32 +14,32 @@ global $wpdb; $wp_postmeta = "{$wpdb->prefix}postmeta"; try { - $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); - // Error Handling - $sql = "UPDATE {$wp_postmeta} SET meta_value = REPLACE(meta_value,'-scaled.jpg','.jpg') WHERE meta_key='_wp_attached_file' AND meta_value LIKE '%-scaled.jpg%'"; - $result = $pdo->exec($sql); - print_r($result); + $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); + // Error Handling + $sql = "UPDATE {$wp_postmeta} SET meta_value = REPLACE(meta_value,'-scaled.jpg','.jpg') WHERE meta_key='_wp_attached_file' AND meta_value LIKE '%-scaled.jpg%'"; + $result = $pdo->exec($sql); + print_r($result); } catch (PDOException $e) { - print_r($e->getMessage()); + print_r($e->getMessage()); } // replace _wp_attachment_metadata meta_key. $image_metas = []; try { - $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); - // Error Handling - $sql = "SELECT * FROM {$wp_postmeta} WHERE meta_value LIKE '%-scaled.jpg%' AND meta_key='_wp_attachment_metadata'"; - $statement = $pdo->query($sql); - $image_metas = $statement->fetchAll(); - foreach ($image_metas as $meta) { - $meta_value = unserialize($meta['meta_value']); - $file = $meta_value['file']; - $meta_value['file'] = str_replace('-scaled.jpg', '.jpg', $file); - update_post_meta($meta['post_id'], $meta['meta_key'], $meta_value); - $result = get_post_meta($meta['post_id'], $meta['meta_key']); - print_r($result); - } + $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); + // Error Handling + $sql = "SELECT * FROM {$wp_postmeta} WHERE meta_value LIKE '%-scaled.jpg%' AND meta_key='_wp_attachment_metadata'"; + $statement = $pdo->query($sql); + $image_metas = $statement->fetchAll(); + foreach ($image_metas as $meta) { + $meta_value = unserialize($meta['meta_value']); + $file = $meta_value['file']; + $meta_value['file'] = str_replace('-scaled.jpg', '.jpg', $file); + update_post_meta($meta['post_id'], $meta['meta_key'], $meta_value); + $result = get_post_meta($meta['post_id'], $meta['meta_key']); + print_r($result); + } } catch (PDOException $e) { - print_r($e->getMessage()); + print_r($e->getMessage()); } diff --git a/tests/playwright/capture.spec.ts b/tests/playwright/capture.spec.ts index 2b2ee074..7b54806e 100644 --- a/tests/playwright/capture.spec.ts +++ b/tests/playwright/capture.spec.ts @@ -37,7 +37,7 @@ Array.from([ }, ]).forEach(({ pageName, url }) => { test.skip(pageName, async ({ page }, testInfo) => { - await page.goto(url); + await page["goto"](url); const projectName = testInfo.project.name; const timestamp: string = genTimestamp(); diff --git a/tests/playwright/product.spec.ts b/tests/playwright/product.spec.ts index ab8abb85..a71f4b5f 100644 --- a/tests/playwright/product.spec.ts +++ b/tests/playwright/product.spec.ts @@ -1,11 +1,13 @@ -import { test as base, expect, Response } from "@playwright/test"; -import { +import type { Response } from "@playwright/test"; +import { expect, test as base } from "@playwright/test"; +import { pipe } from "effect"; +import { not } from "effect/Boolean"; +import type { WCV3Product, WCV3Products, } from "../../web/app/themes/haiku-atelier-2024/src/scripts/lib/types/api/v3/products"; -import { BackendHeaders, getBackendHeadersFromHtml } from "./utils.ts"; -import { pipe } from "effect"; -import { not } from "effect/Boolean"; +import type { BackendHeaders } from "./utils.ts"; +import { getBackendHeadersFromHtml } from "./utils.ts"; /* * Faire un premier test simple où l'on clic sur la première carte du shop @@ -30,7 +32,7 @@ type ProductsKinds = { export const test = base.extend({ products: async ({ page, request }, use) => { - await page.goto("/shop"); + await page["goto"]("/shop"); const backendHeaders: BackendHeaders = await getBackendHeadersFromHtml(page); const response = await request.get("/wp-json/wc/v3/products?page=1&per_page=100&status=publish", { @@ -68,7 +70,7 @@ test("can add a Product without variation with stock to the Cart", async ({ page } // Va à la page du Produit. - await page.goto(randomProduct.permalink); + await page["goto"](randomProduct.permalink); // Vérifie le bon état du bouton de l'ajout au Panier. const addToCartButton = page.getByRole("button", { disabled: false, name: "Add to cart" }); @@ -101,7 +103,7 @@ test("can't add a Product without variation without stock to the Cart", async ({ } // Va à la page du Produit. - await page.goto(randomProduct.permalink); + await page["goto"](randomProduct.permalink); // Vérifie le bon état du bouton de l'ajout au Panier. const outOfStockButton = page.getByRole("button", { disabled: true, name: "Out of stock" }); diff --git a/tests/playwright/shop.spec.ts b/tests/playwright/shop.spec.ts index b3f23c9b..ec8a092c 100644 --- a/tests/playwright/shop.spec.ts +++ b/tests/playwright/shop.spec.ts @@ -1,6 +1,8 @@ -import { APIRequestContext, expect, Locator, Page, Response, test } from "@playwright/test"; -import { WCV3Products } from "../../web/app/themes/haiku-atelier-2024/src/scripts/lib/types/api/v3/products"; -import { BackendHeaders, getBackendHeadersFromHtml } from "./utils.ts"; +import type { APIRequestContext, Locator, Page, Response } from "@playwright/test"; +import { expect, test } from "@playwright/test"; +import type { WCV3Products } from "../../web/app/themes/haiku-atelier-2024/src/scripts/lib/types/api/v3/products"; +import type { BackendHeaders } from "./utils.ts"; +import { getBackendHeadersFromHtml } from "./utils.ts"; test.describe.configure({ mode: "parallel", timeout: 60_000 }); @@ -9,13 +11,13 @@ test("can scroll to the end of the grid", async ({ page }): Promise => { }); test.skip("can access all Products' pages", async ({ page, request }): Promise => { - await page.goto("https://haikuatelier.gcch.local/shop/"); + await page["goto"]("https://haikuatelier.gcch.local/shop/"); const links = await getAllProductsLinks(page, request); for (const link of links) { // Vérifie que le lien de la page retourne OK. - const req = await request.get(link as string); - expect(req, "The Product's page is accessible").toBeOK(); + const req = await request.get(link); + await expect(req, "The Product's page is accessible").toBeOK(); } }); @@ -25,11 +27,11 @@ const getAllProductsLinks = async (page: Page, request: APIRequestContext): Prom headers: { Authorization: `Basic ${backendHeaders.authString}`, Nonce: backendHeaders.nonce }, }); const json = (await response.json()) as WCV3Products; - return json.map((p) => p.permalink); + return json.map(p => p.permalink); }; const scrollToGridsEnd = async (page: Page): Promise => { - await page.goto("https://haikuatelier.gcch.local/shop/"); + await page["goto"]("https://haikuatelier.gcch.local/shop/"); let hasMoreProducts = true; let currentPageNumber = "1"; diff --git a/tests/playwright/utils.ts b/tests/playwright/utils.ts index 0c12dda9..87778b5c 100644 --- a/tests/playwright/utils.ts +++ b/tests/playwright/utils.ts @@ -1,5 +1,5 @@ import { Option, pipe } from "effect"; -import { Page } from "playwright/test"; +import type { Page } from "playwright/test"; export type BackendHeaders = { authString: string; @@ -12,7 +12,7 @@ export type BackendHeaders = { export const getBackendHeadersFromHtml = async (page: Page): Promise => { const backendHeaders: BackendHeaders | undefined = pipe( Option.fromNullishOr(await page.locator("#injection-v2").textContent()), - Option.andThen((j) => JSON.parse(j) as BackendHeaders), + Option.andThen(j => JSON.parse(j) as BackendHeaders), Option.getOrUndefined, ); diff --git a/tsconfig.json b/tsconfig.json index 9c727d57..7653e882 100755 --- a/tsconfig.json +++ b/tsconfig.json @@ -12,7 +12,12 @@ "exactOptionalPropertyTypes": true, "forceConsistentCasingInFileNames": true, "isolatedModules": true, - "lib": ["DOM", "DOM.Iterable", "DOM.AsyncIterable", "ESNext"], + "lib": [ + "DOM", + "DOM.AsyncIterable", + "DOM.Iterable", + "ESNext" + ], "libReplacement": true, "module": "ESNext", "moduleDetection": "force", @@ -41,10 +46,20 @@ "strictNullChecks": true, "strictPropertyInitialization": true, "target": "ESNext", - "types": ["node", "vite/client"], + "types": [ + "node", + "vite/client" + ], "useDefineForClassFields": true, "useUnknownInCatchVariables": true }, - "exclude": ["vendor", "web/app/plugins", "web/wp"], - "include": ["**/*.js", "**/*.ts"] + "exclude": [ + "vendor", + "web/app/plugins", + "web/wp" + ], + "include": [ + "**/*.js", + "**/*.ts" + ] } diff --git a/web/app/themes/haiku-atelier-2024/404.php b/web/app/themes/haiku-atelier-2024/404.php index f6296dd4..b0fe35de 100755 --- a/web/app/themes/haiku-atelier-2024/404.php +++ b/web/app/themes/haiku-atelier-2024/404.php @@ -22,11 +22,12 @@ $templates = ['404.twig']; * * @throws Exception une exception est levée s'il est impossible d'obtenir la date de modification du fichier à charger */ -function load_page_resources(): void { - Resource::enqueue_style_file( - handle: 'haiku-atelier-2024-styles-page-a-propos', - path: '/assets/css/pages/page-modele-simple.css', - ); +function load_page_resources(): void +{ + Resource::enqueue_style_file( + handle: 'haiku-atelier-2024-styles-page-a-propos', + path: '/assets/css/pages/page-modele-simple.css', + ); } add_action('wp_enqueue_scripts', load_page_resources(...)); diff --git a/web/app/themes/haiku-atelier-2024/assets/vendor/controle-personnalise-tinymce.js b/web/app/themes/haiku-atelier-2024/assets/vendor/controle-personnalise-tinymce.js index 41e22ee0..af14fb7e 100755 --- a/web/app/themes/haiku-atelier-2024/assets/vendor/controle-personnalise-tinymce.js +++ b/web/app/themes/haiku-atelier-2024/assets/vendor/controle-personnalise-tinymce.js @@ -1,4 +1,4 @@ -jQuery(document).ready(function ($) { +jQuery(document).ready(function($) { "use strict"; /** @@ -9,7 +9,7 @@ jQuery(document).ready(function ($) { * @link https://github.com/maddisondesigns */ - $(".customize-control-tinymce-editor").each(function () { + $(".customize-control-tinymce-editor").each(function() { // Get the toolbar strings that were passed from the PHP Class const tinyMCEToolbar1String = _wpCustomizeSettings.controls[$(this).attr("id")].skyrockettinymcetoolbar1; const tinyMCEToolbar2String = _wpCustomizeSettings.controls[$(this).attr("id")].skyrockettinymcetoolbar2; @@ -19,14 +19,14 @@ jQuery(document).ready(function ($) { mediaButtons: tinyMCEMediaButtons, quicktags: true, tinymce: { - wpautop: true, toolbar1: tinyMCEToolbar1String, toolbar2: tinyMCEToolbar2String, + wpautop: true, }, }); }); - $(document).on("tinymce-editor-init", function (event, editor) { - editor.on("change", function (e) { + $(document).on("tinymce-editor-init", function(event, editor) { + editor.on("change", function(e) { tinyMCE.triggerSave(); $("#" + editor.id).trigger("change"); }); diff --git a/web/app/themes/haiku-atelier-2024/front-page.php b/web/app/themes/haiku-atelier-2024/front-page.php index 5b890db9..0d9f16cc 100755 --- a/web/app/themes/haiku-atelier-2024/front-page.php +++ b/web/app/themes/haiku-atelier-2024/front-page.php @@ -17,14 +17,14 @@ $context = Timber::context(); $templates = ['accueil.twig']; add_action('wp_enqueue_scripts', function (): void { - Resource::enqueue_style_file( - handle: 'haiku-atelier-2024-styles-page-accueil', - path: '/assets/css/pages/page-accueil.css', - ); - Resource::enqueue_script_module_file( - id: 'haiku-atelier-2024-scripts-page-accueil', - path: '/assets/js/scripts-page-accueil.js', - ); + Resource::enqueue_style_file( + handle: 'haiku-atelier-2024-styles-page-accueil', + path: '/assets/css/pages/page-accueil.css', + ); + Resource::enqueue_script_module_file( + id: 'haiku-atelier-2024-scripts-page-accueil', + path: '/assets/js/scripts-page-accueil.js', + ); }); Timber::render(data: $context, filenames: $templates); diff --git a/web/app/themes/haiku-atelier-2024/page-about.php b/web/app/themes/haiku-atelier-2024/page-about.php index 6d8690be..ce53c103 100755 --- a/web/app/themes/haiku-atelier-2024/page-about.php +++ b/web/app/themes/haiku-atelier-2024/page-about.php @@ -24,20 +24,20 @@ $templates = ['a-propos.twig']; $image_dimensions = getimagesize(filename: get_template_directory() . '/assets/img/about/haikuabout.png'); if (is_bool($image_dimensions)) { - throw new Exception("Impossible d'obtenir les dimensions de l'image principale de la page."); + throw new Exception("Impossible d'obtenir les dimensions de l'image principale de la page."); } $context['image_dimensions'] = $image_dimensions; add_action('wp_enqueue_scripts', function (): void { - Resource::enqueue_style_file( - handle: 'haiku-atelier-2024-styles-page-a-propos', - path: '/assets/css/pages/page-a-propos.css', - ); - Resource::enqueue_script_module_file( - id: 'haiku-atelier-2024-scripts-page-a-propos', - path: '/assets/js/scripts-page-a-propos.js', - ); + Resource::enqueue_style_file( + handle: 'haiku-atelier-2024-styles-page-a-propos', + path: '/assets/css/pages/page-a-propos.css', + ); + Resource::enqueue_script_module_file( + id: 'haiku-atelier-2024-scripts-page-a-propos', + path: '/assets/js/scripts-page-a-propos.js', + ); }); Timber::render(data: $context, filenames: $templates); diff --git a/web/app/themes/haiku-atelier-2024/page-checkout.php b/web/app/themes/haiku-atelier-2024/page-checkout.php index fa08f444..e53ed6c3 100755 --- a/web/app/themes/haiku-atelier-2024/page-checkout.php +++ b/web/app/themes/haiku-atelier-2024/page-checkout.php @@ -22,20 +22,22 @@ use WC_Session_Handler; header('Content-Type: application/json; charset=utf-8'); // TODO: Appliquer le bon calcul pour les montants vs. percentages -function get_discount_amount(WC_Coupon $coupon) { - if ($coupon->get_discount_type() === 'fixed_cart') { - return $coupon->get_amount() * 100; - } else { - return $coupon->get_amount(); - } +function get_discount_amount(WC_Coupon $coupon) +{ + if ($coupon->get_discount_type() === 'fixed_cart') { + return $coupon->get_amount() * 100; + } else { + return $coupon->get_amount(); + } } -function get_discount_duration(WC_Coupon $coupon): string { - if ($coupon->get_discount_type() === 'fixed_cart') { - return 'once'; - } else { - return 'forever'; - } +function get_discount_duration(WC_Coupon $coupon): string +{ + if ($coupon->get_discount_type() === 'fixed_cart') { + return 'once'; + } else { + return 'forever'; + } } // Récupère les informations nécessaires @@ -44,37 +46,37 @@ $session_wc = WC()->session; /** @var array $urls URLs utilisables pour rediriger l'Utilisateur. */ $urls = [ - 'accueil' => get_page_link(get_page_by_path('home')), - 'succes_commande' => get_page_link(get_page_by_path('successful-order')), - 'echec_commande' => get_page_link(get_page_by_path('failed-order')), + 'accueil' => get_page_link(get_page_by_path('home')), + 'succes_commande' => get_page_link(get_page_by_path('successful-order')), + 'echec_commande' => get_page_link(get_page_by_path('failed-order')), ]; // Redirige à la page d'accueil si le Panier est vide if (WC()->cart->is_empty()) { - header('Location: ' . $urls['accueil']); + header('Location: ' . $urls['accueil']); - return; + return; } // Vérifie que les paramètres d'URLs nécessaires soient présents /** @var string $order_id */ $order_id = $_GET['order_id']; if (!$order_id) { - $reponse = ['succes' => false, 'status' => 'order_key is missing']; - echo json_encode($reponse); - http_response_code(400); + $reponse = ['succes' => false, 'status' => 'order_key is missing']; + echo json_encode($reponse); + http_response_code(400); - return; + return; } /** @var string $order_key */ $order_key = $_GET['order_key']; if (!$order_key) { - $reponse = ['succes' => false, 'status' => 'order_key is missing']; - echo json_encode($reponse); - http_response_code(400); + $reponse = ['succes' => false, 'status' => 'order_key is missing']; + echo json_encode($reponse); + http_response_code(400); - return; + return; } // Récupère le Panier et l'Email du Client @@ -86,29 +88,29 @@ $email_client = WC()->session->get('customer')['email']; /** @var list $articles */ $articles = collect($panier->get_cart()) - ->map(static function ($article_panier) { - $titre_produit = match ('variable' === $article_panier['data']?->get_type()) { - true => $article_panier['data']?->get_title() - . ' (' - . explode(': ', (string) $article_panier['data']?->get_attribute_summary())[1] - . ')', - false => $article_panier['data']?->get_title(), - }; + ->map(static function ($article_panier) { + $titre_produit = match ('variable' === $article_panier['data']?->get_type()) { + true => $article_panier['data']?->get_title() + . ' (' + . explode(': ', (string) $article_panier['data']?->get_attribute_summary())[1] + . ')', + false => $article_panier['data']?->get_title(), + }; - return [ - 'price_data' => [ - 'currency' => 'EUR', - 'product_data' => [ - 'name' => $titre_produit, - 'images' => [wp_get_attachment_image_url($article_panier['data']?->get_image_id())], - ], - 'unit_amount' => $article_panier['data']?->get_price() * 100, - ], - 'quantity' => $article_panier['quantity'], - ]; - }) - ->values() - ->toArray(); + return [ + 'price_data' => [ + 'currency' => 'EUR', + 'product_data' => [ + 'name' => $titre_produit, + 'images' => [wp_get_attachment_image_url($article_panier['data']?->get_image_id())], + ], + 'unit_amount' => $article_panier['data']?->get_price() * 100, + ], + 'quantity' => $article_panier['quantity'], + ]; + }) + ->values() + ->toArray(); // Récupère la Commande et la Méthode de Livraison /** @var WC_Order $commande */ @@ -118,7 +120,7 @@ $methode_livraison = ['nom' => $commande->get_shipping_method(), 'cout' => $comm // Le nom de la méthode de livraison ne peut être une chaîne vide. if (empty($methode_livraison['nom'])) { - $methode_livraison['nom'] = 'Free'; + $methode_livraison['nom'] = 'Free'; } // Sélectionne la clé API Stripe @@ -127,39 +129,39 @@ Stripe::setApiKey(Config::get('STRIPE_API_SECRET')); // Met à jour les Codes promos $coupons_stripe = collect(Coupon::all()->data); $coupons_wc = collect(WC()->cart->get_coupons()) - ->map(static fn(WC_Coupon $coupon): array => [ - 'currency' => 'EUR', - 'duration' => get_discount_duration($coupon), - 'fixed_cart' === $coupon->get_discount_type() ? 'amount_off' : 'percent_off' => get_discount_amount($coupon), - 'id' => $coupon->get_code(), - 'name' => $coupon->get_code(), - ]) - ->each(static function (array $item) use ($coupons_stripe): void { - // Si le code promo n'existe pas, le créer - if (!$coupons_stripe->contains('name', $item['name'])) { - Coupon::create($item); - } - }); + ->map(static fn(WC_Coupon $coupon): array => [ + 'currency' => 'EUR', + 'duration' => get_discount_duration($coupon), + 'fixed_cart' === $coupon->get_discount_type() ? 'amount_off' : 'percent_off' => get_discount_amount($coupon), + 'id' => $coupon->get_code(), + 'name' => $coupon->get_code(), + ]) + ->each(static function (array $item) use ($coupons_stripe): void { + // Si le code promo n'existe pas, le créer + if (!$coupons_stripe->contains('name', $item['name'])) { + Coupon::create($item); + } + }); $reductions_stripe = $coupons_wc - ->map(static fn($coupon): array => ['coupon' => $coupon['name']]) - ->values() - ->toArray(); + ->map(static fn($coupon): array => ['coupon' => $coupon['name']]) + ->values() + ->toArray(); /** @var Session $session_checkout_stripe */ $session_checkout_stripe = Session::create([ - 'cancel_url' => $urls['echec_commande'], - 'customer_email' => $email_client, - 'discounts' => $reductions_stripe, - 'line_items' => $articles, - 'mode' => 'payment', - 'success_url' => $urls['succes_commande'] . '?session_id={CHECKOUT_SESSION_ID}', - 'metadata' => ['order_id' => $order_id, 'order_key' => $order_key], - 'shipping_options' => [['shipping_rate_data' => [ - 'display_name' => $methode_livraison['nom'], - 'fixed_amount' => ['amount' => $methode_livraison['cout'], 'currency' => 'EUR'], - 'tax_behavior' => 'inclusive', - 'type' => 'fixed_amount', - ]]], + 'cancel_url' => $urls['echec_commande'], + 'customer_email' => $email_client, + 'discounts' => $reductions_stripe, + 'line_items' => $articles, + 'mode' => 'payment', + 'success_url' => $urls['succes_commande'] . '?session_id={CHECKOUT_SESSION_ID}', + 'metadata' => ['order_id' => $order_id, 'order_key' => $order_key], + 'shipping_options' => [['shipping_rate_data' => [ + 'display_name' => $methode_livraison['nom'], + 'fixed_amount' => ['amount' => $methode_livraison['cout'], 'currency' => 'EUR'], + 'tax_behavior' => 'inclusive', + 'type' => 'fixed_amount', + ]]], ], ['idempotency_key' => Uuid::v4()]); // echo json_encode($session_checkout_stripe); header('HTTP/1.1 303 See Other'); diff --git a/web/app/themes/haiku-atelier-2024/page-failed-order.php b/web/app/themes/haiku-atelier-2024/page-failed-order.php index ea428114..1dc703c5 100755 --- a/web/app/themes/haiku-atelier-2024/page-failed-order.php +++ b/web/app/themes/haiku-atelier-2024/page-failed-order.php @@ -17,10 +17,10 @@ $context = Timber::context(); $templates = ['echec-commande.twig']; add_action('wp_enqueue_scripts', function (): void { - Resource::enqueue_style_file( - handle: 'haiku-atelier-2024-styles-page-modele-simple', - path: '/assets/css/pages/page-modele-simple.css', - ); + Resource::enqueue_style_file( + handle: 'haiku-atelier-2024-styles-page-modele-simple', + path: '/assets/css/pages/page-modele-simple.css', + ); }); // Rendu diff --git a/web/app/themes/haiku-atelier-2024/page-terms-and-conditions.php b/web/app/themes/haiku-atelier-2024/page-terms-and-conditions.php index 0b9d5998..d5584c86 100755 --- a/web/app/themes/haiku-atelier-2024/page-terms-and-conditions.php +++ b/web/app/themes/haiku-atelier-2024/page-terms-and-conditions.php @@ -17,10 +17,10 @@ $context = Timber::context(); $templates = ['cgv.twig']; add_action('wp_enqueue_scripts', function (): void { - Resource::enqueue_style_file( - handle: '/assets/css/pages/page-modele-simple.css', - path: '/assets/css/pages/page-modele-simple.css', - ); + Resource::enqueue_style_file( + handle: '/assets/css/pages/page-modele-simple.css', + path: '/assets/css/pages/page-modele-simple.css', + ); }); // Rendu diff --git a/web/app/themes/haiku-atelier-2024/single-product.php b/web/app/themes/haiku-atelier-2024/single-product.php index cfa0bfec..e08501e1 100755 --- a/web/app/themes/haiku-atelier-2024/single-product.php +++ b/web/app/themes/haiku-atelier-2024/single-product.php @@ -45,6 +45,7 @@ $maximum_price = collect($product->variations)->max('price'); $same_collection_products = Product::get_same_collection_products($product->collection)($product->id) |> function (/** @var list|stdClass */ mixed $products): array { assert(is_array($products), 'Les Produits de la même collection doivent être un tableau.'); + return $products; } |> (static fn(/** @var list */ array $products): array => Arr::map( diff --git a/web/app/themes/haiku-atelier-2024/src/StarterSite.php b/web/app/themes/haiku-atelier-2024/src/StarterSite.php index 846929a6..016d7146 100755 --- a/web/app/themes/haiku-atelier-2024/src/StarterSite.php +++ b/web/app/themes/haiku-atelier-2024/src/StarterSite.php @@ -170,6 +170,7 @@ final class StarterSite extends Site { public function maj_environnement_twig(array $options): array { return $options; } + // public function charge_traductions_theme(): void { // load_theme_textdomain("haiku-atelier-2024", get_template_directory() . "/languages"); // } diff --git a/web/app/themes/haiku-atelier-2024/src/inc/ChampsPersonnalises.php b/web/app/themes/haiku-atelier-2024/src/inc/ChampsPersonnalises.php index 9d509e72..e64ba66b 100755 --- a/web/app/themes/haiku-atelier-2024/src/inc/ChampsPersonnalises.php +++ b/web/app/themes/haiku-atelier-2024/src/inc/ChampsPersonnalises.php @@ -9,36 +9,39 @@ declare(strict_types=1); use Carbon_Fields\Container; use Carbon_Fields\Field; -function cree_champs_personnalises_produit(): void { - Container::make('post_meta', "Product's Details") - ->where('post_type', '=', 'product') - ->add_fields([ - // Galerie des photos Produit - Field::make('media_gallery', 'photos_colonne_gauche', __('Left Column Photos')) - ->set_type(['image']) - ->set_duplicates_allowed(false), - // Galerie des photos portées - Field::make('media_gallery', 'photos_colonne_droite', __('Right Column Photos')) - ->set_type(['image']) - ->set_duplicates_allowed(false), - // Texte des détails du Produit - Field::make('rich_text', 'haiku_details_produit', __("Product's Details")), +function cree_champs_personnalises_produit(): void +{ + Container::make('post_meta', "Product's Details") + ->where('post_type', '=', 'product') + ->add_fields([ + // Galerie des photos Produit + Field::make('media_gallery', 'photos_colonne_gauche', __('Left Column Photos')) + ->set_type(['image']) + ->set_duplicates_allowed(false), + // Galerie des photos portées + Field::make('media_gallery', 'photos_colonne_droite', __('Right Column Photos')) + ->set_type(['image']) + ->set_duplicates_allowed(false), + // Texte des détails du Produit + Field::make('rich_text', 'haiku_details_produit', __("Product's Details")), + ]); +} + +function cree_champ_personnalise_commande($order): void +{ + woocommerce_wp_text_input([ + 'id' => 'tracking_number', + 'label' => 'Tracking Number:', + 'value' => $order->get_meta('tracking_number'), + 'wrapper_class' => 'form-field-wide', ]); } -function cree_champ_personnalise_commande($order): void { - woocommerce_wp_text_input([ - 'id' => 'tracking_number', - 'label' => 'Tracking Number:', - 'value' => $order->get_meta('tracking_number'), - 'wrapper_class' => 'form-field-wide', - ]); -} - -function maj_champ_personnalise_commande($order_id): void { - $order = wc_get_order($order_id); - $order->update_meta_data('tracking_number', wc_clean($_POST['tracking_number'])); - $order->save(); +function maj_champ_personnalise_commande($order_id): void +{ + $order = wc_get_order($order_id); + $order->update_meta_data('tracking_number', wc_clean($_POST['tracking_number'])); + $order->save(); } add_action('carbon_fields_register_fields', 'cree_champs_personnalises_produit'); diff --git a/web/app/themes/haiku-atelier-2024/src/inc/ControlesPersonnalises.php b/web/app/themes/haiku-atelier-2024/src/inc/ControlesPersonnalises.php index 78d633cd..9209a485 100755 --- a/web/app/themes/haiku-atelier-2024/src/inc/ControlesPersonnalises.php +++ b/web/app/themes/haiku-atelier-2024/src/inc/ControlesPersonnalises.php @@ -8,69 +8,74 @@ declare(strict_types=1); -function enregistre_controle_personnalise_tinymce(): void { - /** - * TinyMCE Custom Control. - * - * @author Anthony Hortin - * @license http://www.gnu.org/licenses/gpl-2.0.html - * - * @see https://github.com/maddisondesigns - */ - final class ControlesPersonnalises extends WP_Customize_Control { - /** The type of control being rendered. */ - public $type = 'editeur_tinymce'; - +function enregistre_controle_personnalise_tinymce(): void +{ /** - * Enqueue our scripts and styles. + * TinyMCE Custom Control. + * + * @author Anthony Hortin + * @license http://www.gnu.org/licenses/gpl-2.0.html + * + * @see https://github.com/maddisondesigns */ - public function enqueue(): void { - wp_enqueue_script( - handle: 'controle-personnalise-tinymce', - src: get_template_directory_uri() . '/assets/vendor/controle-personnalise-tinymce.js', - deps: ['jquery'], - ver: '1.3', - args: true, - ); - wp_enqueue_editor(); - } + final class ControlesPersonnalises extends WP_Customize_Control + { + /** The type of control being rendered. */ + public $type = 'editeur_tinymce'; - /** - * Render the control in the customizer. - */ - public function render_content(): void { ?> + /** + * Enqueue our scripts and styles. + */ + public function enqueue(): void + { + wp_enqueue_script( + handle: 'controle-personnalise-tinymce', + src: get_template_directory_uri() . '/assets/vendor/controle-personnalise-tinymce.js', + deps: ['jquery'], + ver: '1.3', + args: true, + ); + wp_enqueue_editor(); + } + + /** + * Render the control in the customizer. + */ + public function render_content(): void + { ?>
label); ?> description)) { ?> description); ?>
json['skyrockettinymcetoolbar1'] = isset($this->input_attrs['toolbar1']) - ? esc_attr($this->input_attrs['toolbar1']) - : 'bold italic bullist numlist alignleft aligncenter alignright link'; + $this->json['skyrockettinymcetoolbar1'] = isset($this->input_attrs['toolbar1']) + ? esc_attr($this->input_attrs['toolbar1']) + : 'bold italic bullist numlist alignleft aligncenter alignright link'; - $this->json['skyrockettinymcetoolbar2'] = isset($this->input_attrs['toolbar2']) - ? esc_attr($this->input_attrs['toolbar2']) - : ''; - $this->json['skyrocketmediabuttons'] = isset($this->input_attrs['mediaButtons']) - && $this->input_attrs['mediaButtons'] === true - ? true - : false; + $this->json['skyrockettinymcetoolbar2'] = isset($this->input_attrs['toolbar2']) + ? esc_attr($this->input_attrs['toolbar2']) + : ''; + $this->json['skyrocketmediabuttons'] = isset($this->input_attrs['mediaButtons']) + && $this->input_attrs['mediaButtons'] === true + ? true + : false; + } } - } } add_action('customize_register', 'enregistre_controle_personnalise_tinymce'); diff --git a/web/app/themes/haiku-atelier-2024/src/inc/Data/Cart.php b/web/app/themes/haiku-atelier-2024/src/inc/Data/Cart.php index f4eecd5f..248f4bc2 100644 --- a/web/app/themes/haiku-atelier-2024/src/inc/Data/Cart.php +++ b/web/app/themes/haiku-atelier-2024/src/inc/Data/Cart.php @@ -11,112 +11,116 @@ use function is_float; use function is_int; use function is_string; -final readonly class Cart { - public function __construct() {} +final readonly class Cart +{ + public function __construct() {} - /** La valeur par défaut d'une donnée invalide du Panier. */ - private const string DEFAULT_VALUE = '0.00'; + /** La valeur par défaut d'une donnée invalide du Panier. */ + private const string DEFAULT_VALUE = '0.00'; - /** - * Retourne la liste des pays acceptés pour la livraison. - * - * @return array - */ - public static function get_allowed_countries(): array { - return [ - 'AD', - 'AL', - 'AM', - 'AR', - 'AT', - 'AU', - 'BA', - 'BE', - 'BG', - 'BR', - 'CA', - 'CH', - 'CL', - 'CR', - 'CU', - 'CY', - 'CZ', - 'DE', - 'DK', - 'DZ', - 'EE', - 'EG', - 'ES', - 'FI', - 'FR', - 'GF', - 'GP', - 'GR', - 'HR', - 'HU', - 'IE', - 'IS', - 'IT', - 'JP', - 'KR', - 'LB', - 'LI', - 'LT', - 'LU', - 'LV', - 'MA', - 'MD', - 'ME', - 'MF', - 'MQ', - 'MT', - 'MX', - 'NC', - 'NL', - 'NO', - 'NZ', - 'PF', - 'PL', - 'PM', - 'PS', - 'PT', - 'RE', - 'RO', - 'SE', - 'SI', - 'SK', - 'SM', - 'TN', - 'TR', - 'TW', - 'US', - 'YT', - 'ZA', - ]; - } - - public static function parse_cart_value(int|float|string|bool $cart_value): string { - if (is_int($cart_value) || is_float($cart_value)) { - return self::format_number($cart_value); + /** + * Retourne la liste des pays acceptés pour la livraison. + * + * @return array + */ + public static function get_allowed_countries(): array + { + return [ + 'AD', + 'AL', + 'AM', + 'AR', + 'AT', + 'AU', + 'BA', + 'BE', + 'BG', + 'BR', + 'CA', + 'CH', + 'CL', + 'CR', + 'CU', + 'CY', + 'CZ', + 'DE', + 'DK', + 'DZ', + 'EE', + 'EG', + 'ES', + 'FI', + 'FR', + 'GF', + 'GP', + 'GR', + 'HR', + 'HU', + 'IE', + 'IS', + 'IT', + 'JP', + 'KR', + 'LB', + 'LI', + 'LT', + 'LU', + 'LV', + 'MA', + 'MD', + 'ME', + 'MF', + 'MQ', + 'MT', + 'MX', + 'NC', + 'NL', + 'NO', + 'NZ', + 'PF', + 'PL', + 'PM', + 'PS', + 'PT', + 'RE', + 'RO', + 'SE', + 'SI', + 'SK', + 'SM', + 'TN', + 'TR', + 'TW', + 'US', + 'YT', + 'ZA', + ]; } - if (is_string($cart_value)) { - $number = Number::parseInt($cart_value); - $number = is_bool($number) ? 0 : $number; + public static function parse_cart_value(int|float|string|bool $cart_value): string + { + if (is_int($cart_value) || is_float($cart_value)) { + return self::format_number($cart_value); + } - return self::format_number($number); + if (is_string($cart_value)) { + $number = Number::parseInt($cart_value); + $number = is_bool($number) ? 0 : $number; + + return self::format_number($number); + } + + return '0.00'; } - return '0.00'; - } - - private static function format_number(int|float $number): string { - $formatted_number = Number::format( - number: $number, - // precision et max_precision sont mutuellement exclusifs. - precision: 2, - locale: 'fr', - ); - return is_bool($formatted_number) ? self::DEFAULT_VALUE : $formatted_number; - } + private static function format_number(int|float $number): string + { + $formatted_number = Number::format( + number: $number, + // precision et max_precision sont mutuellement exclusifs. + precision: 2, + locale: 'fr', + ); + return is_bool($formatted_number) ? self::DEFAULT_VALUE : $formatted_number; + } } diff --git a/web/app/themes/haiku-atelier-2024/src/inc/Data/ProductVariation.php b/web/app/themes/haiku-atelier-2024/src/inc/Data/ProductVariation.php index 11104db0..eb4e5b95 100644 --- a/web/app/themes/haiku-atelier-2024/src/inc/Data/ProductVariation.php +++ b/web/app/themes/haiku-atelier-2024/src/inc/Data/ProductVariation.php @@ -6,32 +6,34 @@ namespace HaikuAtelier\Data; use WC_Product; -final readonly class ProductVariation { - /** - * @param int $id L'ID de la Variation - * @param string $price Le prix de la Variation - * @param list $attributes Les attributs appliqués à la Variation - */ - private function __construct( - public int $id, - public string $price, - public array $attributes, - ) {} +final readonly class ProductVariation +{ + /** + * @param int $id L'ID de la Variation + * @param string $price Le prix de la Variation + * @param list $attributes Les attributs appliqués à la Variation + */ + private function __construct( + public int $id, + public string $price, + public array $attributes, + ) {} - /** - * Créé une nouvelle instance de `ProductVariation` à partir d'un `WC_Product`. - */ - public static function new(WC_Product $product): self { - $id = $product->get_id(); - $price = $product->get_price(); - /** @var list */ - $attributes = array_map( - /** @phpstan-ignore argument.type (Impossible à satisfaire) */ - static fn(string $key, string $value) => new ProductVariationAttribute($key, $value), - array_keys($product->get_attributes()), - array_values($product->get_attributes()), - ); + /** + * Créé une nouvelle instance de `ProductVariation` à partir d'un `WC_Product`. + */ + public static function new(WC_Product $product): self + { + $id = $product->get_id(); + $price = $product->get_price(); + /** @var list */ + $attributes = array_map( + /** @phpstan-ignore argument.type (Impossible à satisfaire) */ + static fn(string $key, string $value) => new ProductVariationAttribute($key, $value), + array_keys($product->get_attributes()), + array_values($product->get_attributes()), + ); - return new self($id, $price, $attributes); - } + return new self($id, $price, $attributes); + } } diff --git a/web/app/themes/haiku-atelier-2024/src/inc/Data/ProductVariationAttribute.php b/web/app/themes/haiku-atelier-2024/src/inc/Data/ProductVariationAttribute.php index 988ee3b4..3bff266e 100644 --- a/web/app/themes/haiku-atelier-2024/src/inc/Data/ProductVariationAttribute.php +++ b/web/app/themes/haiku-atelier-2024/src/inc/Data/ProductVariationAttribute.php @@ -4,13 +4,14 @@ declare(strict_types=1); namespace HaikuAtelier\Data; -final readonly class ProductVariationAttribute { - /** - * @param string $attribute Le slug de l'Attribut - * @param string $value Le slug de la valeur de l'Attribut - */ - public function __construct( - public string $attribute, - public string $value, - ) {} +final readonly class ProductVariationAttribute +{ + /** + * @param string $attribute Le slug de l'Attribut + * @param string $value Le slug de la valeur de l'Attribut + */ + public function __construct( + public string $attribute, + public string $value, + ) {} } diff --git a/web/app/themes/haiku-atelier-2024/src/inc/Fonctionnalites.php b/web/app/themes/haiku-atelier-2024/src/inc/Fonctionnalites.php index 771f1c3d..fc5e8947 100755 --- a/web/app/themes/haiku-atelier-2024/src/inc/Fonctionnalites.php +++ b/web/app/themes/haiku-atelier-2024/src/inc/Fonctionnalites.php @@ -9,8 +9,9 @@ declare(strict_types=1); namespace HaikuAtelier; // Désactive divers transformations du contenu par WordPress -function desactive_wpautop(): void { - remove_filter('the_content', 'wpautop'); +function desactive_wpautop(): void +{ + remove_filter('the_content', 'wpautop'); } /** @@ -20,16 +21,17 @@ function desactive_wpautop(): void { * * @return array le même tableau avec des configurations en plus */ -function desactive_transformation_contenu_tinymce(array $configuration): array { - // Ne supprime pas les retours à la ligne - $configuration['remove_linebreaks'] = false; - // Convertis les caractères de retours à la ligne en
- $configuration['convert_newlines_to_brs'] = true; - // Supprime les
redondants - $configuration['remove_redundant_brs'] = false; +function desactive_transformation_contenu_tinymce(array $configuration): array +{ + // Ne supprime pas les retours à la ligne + $configuration['remove_linebreaks'] = false; + // Convertis les caractères de retours à la ligne en
+ $configuration['convert_newlines_to_brs'] = true; + // Supprime les
redondants + $configuration['remove_redundant_brs'] = false; - // Retourne $configuration à WordPress - return $configuration; + // Retourne $configuration à WordPress + return $configuration; } /** @@ -39,19 +41,22 @@ function desactive_transformation_contenu_tinymce(array $configuration): array { * * @return array le même tableau avec SVG en plus */ -function autorise_import_svg_mediatheque(array $file_types): array { - $new_filetypes = []; - $new_filetypes['svg'] = 'image/svg+xml'; +function autorise_import_svg_mediatheque(array $file_types): array +{ + $new_filetypes = []; + $new_filetypes['svg'] = 'image/svg+xml'; - return [...$file_types, ...$new_filetypes]; + return [...$file_types, ...$new_filetypes]; } -function retire_motifs_blocs_gutenberg(): void { - remove_theme_support('core-block-patterns'); +function retire_motifs_blocs_gutenberg(): void +{ + remove_theme_support('core-block-patterns'); } -function retire_styles_core_block(): void { - wp_dequeue_style('core-block-supports'); +function retire_styles_core_block(): void +{ + wp_dequeue_style('core-block-supports'); } // Désactive les appels à l'API de la mise à jour des traductions diff --git a/web/app/themes/haiku-atelier-2024/src/inc/Taxonomies.php b/web/app/themes/haiku-atelier-2024/src/inc/Taxonomies.php index 727459f0..176f36f6 100755 --- a/web/app/themes/haiku-atelier-2024/src/inc/Taxonomies.php +++ b/web/app/themes/haiku-atelier-2024/src/inc/Taxonomies.php @@ -14,32 +14,33 @@ use function register_taxonomy; /** * Enregistre la Taxonomie « Collection ». */ -function enregistre_taxonomie_collection(): void { - $labels = [ - 'add_new_item' => __('Add New Collection'), - 'all_items' => __('All Collections'), - 'edit_item' => __('Edit Collection'), - 'menu_name' => __('Collections'), - 'name' => __('Collections'), - 'new_item_name' => __('New Collection Name'), - 'search_items' => __('Search Collections'), - 'singular_name' => __('Collection'), - 'update_item' => __('Update Collection'), - ]; - $args = [ - 'description' => __('An ensemble of pieces thematically or chronologically grouped together.'), - 'hierarchical' => false, - 'labels' => $labels, - 'publicly_queryable' => false, - 'query_var' => true, - 'rewrite' => ['slug' => 'collection'], - 'show_admin_column' => true, - 'show_in_menu' => true, - 'show_in_quick_edit' => true, - 'show_ui' => true, - ]; +function enregistre_taxonomie_collection(): void +{ + $labels = [ + 'add_new_item' => __('Add New Collection'), + 'all_items' => __('All Collections'), + 'edit_item' => __('Edit Collection'), + 'menu_name' => __('Collections'), + 'name' => __('Collections'), + 'new_item_name' => __('New Collection Name'), + 'search_items' => __('Search Collections'), + 'singular_name' => __('Collection'), + 'update_item' => __('Update Collection'), + ]; + $args = [ + 'description' => __('An ensemble of pieces thematically or chronologically grouped together.'), + 'hierarchical' => false, + 'labels' => $labels, + 'publicly_queryable' => false, + 'query_var' => true, + 'rewrite' => ['slug' => 'collection'], + 'show_admin_column' => true, + 'show_in_menu' => true, + 'show_in_quick_edit' => true, + 'show_ui' => true, + ]; - register_taxonomy('collection', ['product'], $args); + register_taxonomy('collection', ['product'], $args); } add_action('init', enregistre_taxonomie_collection(...)); diff --git a/web/app/themes/haiku-atelier-2024/src/inc/WP/Post.php b/web/app/themes/haiku-atelier-2024/src/inc/WP/Post.php index 116eb07b..0decb949 100644 --- a/web/app/themes/haiku-atelier-2024/src/inc/WP/Post.php +++ b/web/app/themes/haiku-atelier-2024/src/inc/WP/Post.php @@ -14,46 +14,50 @@ use function is_array; use function Psl\Option\none; use function Psl\Option\some; -final readonly class Post { - /** - * @return Option\Option - */ - public static function get_post_meta(int $post_id, string $key): Option\Option { - /** @var false|mixed|string */ - $value = get_post_meta($post_id, $key, true); +final readonly class Post +{ + /** + * @return Option\Option + */ + public static function get_post_meta(int $post_id, string $key): Option\Option + { + /** @var false|mixed|string */ + $value = get_post_meta($post_id, $key, true); - if ($value === false) { - return none(); + if ($value === false) { + return none(); + } + + return some($value); } - return some($value); - } + /** + * @return Option\Option> + */ + public static function get_post_meta_array(int $post_id, string $key): Option\Option + { + /** @var array|false */ + $value = get_post_meta($post_id, $key, false); - /** - * @return Option\Option> - */ - public static function get_post_meta_array(int $post_id, string $key): Option\Option { - /** @var array|false */ - $value = get_post_meta($post_id, $key, false); + if (is_array($value)) { + return some($value); + } - if (is_array($value)) { - return some($value); + return none(); } - return none(); - } + /** + * @return Option\Option> + */ + public static function get_terms(int $post_id, string $taxonomy_name): Option\Option + { + /** @var false|list|WP_Error */ + $terms = get_the_terms($post_id, $taxonomy_name); - /** - * @return Option\Option> - */ - public static function get_terms(int $post_id, string $taxonomy_name): Option\Option { - /** @var false|list|WP_Error */ - $terms = get_the_terms($post_id, $taxonomy_name); + if (is_array($terms)) { + return some($terms); + } - if (is_array($terms)) { - return some($terms); + return none(); } - - return none(); - } } diff --git a/web/app/themes/haiku-atelier-2024/src/scripts-effect/lib/dom.ts b/web/app/themes/haiku-atelier-2024/src/scripts-effect/lib/dom.ts index 4dc5db46..d7f48c4a 100644 --- a/web/app/themes/haiku-atelier-2024/src/scripts-effect/lib/dom.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts-effect/lib/dom.ts @@ -7,13 +7,11 @@ import { getOptionOrThrowWithError } from "./utils.ts"; type ParentElement = Document | Element; const getFirstSelectorFromParent = - (parent: ParentElement) => - (selector: string): Option.Option> => + (parent: ParentElement) => (selector: string): Option.Option> => Option.fromNullishOr(parent.querySelector(selector)); const getFirstSelectorFromParentOrThrow = - (parent: ParentElement) => - (selector: string): NonNullable => + (parent: ParentElement) => (selector: string): NonNullable => pipe( getFirstSelectorFromParent(parent)(selector), getOptionOrThrowWithError(`Il n'y a pas d'Élément dans le parent avec le sélecteur suivant : ${selector}.`), @@ -29,8 +27,7 @@ const getFirstSelectorFromDocumentOrThrow = (select ); const getAllSelectorFromParent = - (parent: ParentElement) => - (selector: string): Option.Option> => + (parent: ParentElement) => (selector: string): Option.Option> => pipe( parent.querySelectorAll(selector), // Convertis NodeListOf en Array. diff --git a/web/app/themes/haiku-atelier-2024/src/scripts-effect/lib/utils.ts b/web/app/themes/haiku-atelier-2024/src/scripts-effect/lib/utils.ts index a550ffe2..fa17ea8a 100644 --- a/web/app/themes/haiku-atelier-2024/src/scripts-effect/lib/utils.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts-effect/lib/utils.ts @@ -1,9 +1,7 @@ import { Option, pipe } from "effect"; -export const getOptionOrThrowWithError = - (message: string) => - (option: Option.Option): T => - pipe( - option, - Option.getOrThrowWith(() => new Error(message)), - ); +export const getOptionOrThrowWithError = (message: string) => (option: Option.Option): T => + pipe( + option, + Option.getOrThrowWith(() => new Error(message)), + ); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/arrays.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/arrays.ts index 865ad499..52ad6bd2 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/arrays.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/arrays.ts @@ -1,18 +1,12 @@ -export const forEach = - (fn: (_1: T) => void) => - (xs: Array): void => { - xs.forEach(fn); - }; +export const forEach = (fn: (_1: T) => void) => (xs: Array): void => { + xs.forEach(fn); +}; -export const forEachWithIndex = - (fn: (_1: T, _2: number) => void) => - (xs: Array): void => { - xs.forEach(fn); - }; +export const forEachWithIndex = (fn: (_1: T, _2: number) => void) => (xs: Array): void => { + xs.forEach(fn); +}; -export const map = - (fn: (_1: T) => void) => - (xs: Array): Array => { - xs.map(fn); - return xs; - }; +export const map = (fn: (_1: T) => void) => (xs: Array): Array => { + xs.map(fn); + return xs; +}; diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/dom.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/dom.ts index d6b2def8..393a1507 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/dom.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/dom.ts @@ -18,26 +18,22 @@ import { } from "./erreurs"; export const recupereElementAvecSelecteur = - (parent: ParentElement) => - (selecteur: string): Either => + (parent: ParentElement) => (selecteur: string): Either => Either // Retourne une SyntaxError dans un Left si le sélecteur est invalide .encase(() => parent.querySelector(selecteur)) // Transforme le Left en une erreur plus sympathique - .mapLeft((_) => creeSyntaxError(ERREUR_SYNTAXE_INVALIDE(selecteur))) + .mapLeft(_ => creeSyntaxError(ERREUR_SYNTAXE_INVALIDE(selecteur))) // Retourne une SyntaxError si l'Élément est null - .chain((e: E | null) => - G.isNotNullable(e) ? Right(e) : Left(creeSyntaxError(ERREUR_DOM_INEXISTANT(selecteur))), - ); + .chain((e: E | null) => G.isNotNullable(e) ? Right(e) : Left(creeSyntaxError(ERREUR_DOM_INEXISTANT(selecteur)))); export const getDOMElementsWithSelector = - (parent: ParentElement) => - (selecteur: string): Either> => + (parent: ParentElement) => (selecteur: string): Either> => Either // Retourne une SyntaxError dans un Left si le sélecteur est invalide .encase(() => pipe(parent.querySelectorAll(selecteur), Array.from)) // Transforme le Left en une erreur plus sympathique - .mapLeft((_) => creeSyntaxError(ERREUR_SYNTAXE_INVALIDE(selecteur))) + .mapLeft(_ => creeSyntaxError(ERREUR_SYNTAXE_INVALIDE(selecteur))) // Retourne une SyntaxError si le tableau est vide .chain((e: Array) => (A.isEmpty(e) ? Left(creeSyntaxError(ERREUR_DOM_INEXISTANT(selecteur))) : Right(e))); @@ -55,20 +51,18 @@ export const recupereElementsOuLeve = ( Right: identity, }); -export const majElementInnerHtml = - (element: T) => - (innerHtml: string) => { - element.innerHTML = innerHtml; - return element; - }; +export const majElementInnerHtml = (element: T) => (innerHtml: string) => { + element.innerHTML = innerHtml; + return element; +}; // Merci facon (https://github.com/terkelg/facon) export const html = (strings: TemplateStringsArray, ...args: Array) => pipe( document.createElement("template"), - (template) => + template => majElementInnerHtml(template)(args.reduce((prev, value, i) => prev + value + strings[i + 1], strings[0])), - (template) => template.content, + template => template.content, ); /** @@ -86,10 +80,8 @@ export const safeJsonParse = (chaine: string): Either => * * @returns Un booléen */ -export const targetMatchesSelector = ( - cible: EventTarget | null, - selecteur: string, -): cible is E => cible !== null && (cible as HTMLElement).matches(selecteur); +export const targetMatchesSelector = (cible: EventTarget | null, selecteur: string): cible is HTMLElement => + (cible as HTMLElement)?.matches(selecteur); export const recupereElementsDocumentEither: ( selecteur: string, @@ -105,13 +97,11 @@ export const recupereElementDocumentEither: (select * @throws Une SyntaxError si l'Élément n'est pas trouvé. * @returns Un Élément. */ -export const mustGetEleInDocument = (selecteur: string): E => - pipe(recupereElementDocumentEither(selecteur), recupereElementOuLeve); +export const mustGetEleInDocument = (selecteur: string): Element => + pipe(recupereElementDocumentEither(selecteur), recupereElementOuLeve); -export const mustGetEleInParent = - (parent: ParentElement) => - (selector: string) => - pipe(recupereElementAvecSelecteur(parent)(selector), recupereElementOuLeve); +export const mustGetEleInParent = (parent: ParentElement) => (selector: string) => + pipe(recupereElementAvecSelecteur(parent)(selector), recupereElementOuLeve); /** * Fonction utilitaire pour récupérer des Éléments selon un sélecteur au sein du Document. @@ -138,11 +128,11 @@ export const setButtonLoadingState = (button: HTMLButtonElement, isLoading: bool }; export const estErreurHttp = (erreur: unknown) => - erreur instanceof BadRequestError || - erreur instanceof ForbiddenError || - erreur instanceof NotFoundError || - erreur instanceof ServerError || - erreur instanceof UnauthorizedError; + erreur instanceof BadRequestError + || erreur instanceof ForbiddenError + || erreur instanceof NotFoundError + || erreur instanceof ServerError + || erreur instanceof UnauthorizedError; export const estErreurFetch = (erreur: unknown) => erreur instanceof DOMException || erreur instanceof TypeError || erreur instanceof Error; diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/erreurs.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/erreurs.ts index 879d14c5..4ea05c41 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/erreurs.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/erreurs.ts @@ -78,7 +78,7 @@ export const Erreur = (message: string): Error => new Error(message); export const ErreurInconnue = (erreur: unknown): UnknownError => new UnknownError(erreur); export const ErreurEntreeInexistante = (message: string): NonExistingKeyError => new NonExistingKeyError(message); -export const leveErreur = (erreur: E): never => { +export const leveErreur = (erreur: Error): never => { throw erreur; }; export const leveBadRequestError = (erreur: WCErrorBody): never => { @@ -106,7 +106,7 @@ export const leveNonExistingKeyError = (message: string): never => { * @param erreur * @returns L'ID Sentry de l'évènement capturé. */ -export const reporteErreur = (erreur: E): string => captureException(erreur); +export const reporteErreur = (erreur: Error): string => captureException(erreur); /** * Reporte une Erreur, sous forme d'erreur console et au service GlitchTip, puis la lève sous forme @@ -115,12 +115,12 @@ export const reporteErreur = (erreur: E): string => captureExce * @param erreur * @returns never Lève une Erreur et ne retourne donc rien. */ -export const reporteEtLeveErreur = (erreur: E): never => { +export const reporteEtLeveErreur = (erreur: Error): never => { reporteErreur(erreur); throw erreur; }; -export const reporteEtJournaliseErreur = (erreur: E): void => { +export const reporteEtJournaliseErreur = (erreur: Error): void => { reporteErreur(erreur); console.error(erreur); if (erreur instanceof ValiError) { diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/evenements/panier.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/evenements/panier.ts index 7e4fa0b3..4272a33b 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/evenements/panier.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/evenements/panier.ts @@ -7,12 +7,12 @@ export const CODE_PROMO_MAJ_EVENT = new CustomEvent(CODE_PROMO_MAJ, {}); // Interfaces -export type UpdatedShippingRatesEvent = { +export type UpdatedShippingRatesEvent = Event & { detail: { refresh_methods: boolean; shipping_rates: ReadonlyArray }; -} & Event; -export type UpdatedTotalsEvent = { +}; +export type UpdatedTotalsEvent = Event & { detail: { totals: WCStoreCartTotals }; -} & Event; +}; // Méthodes diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/gardes.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/gardes.ts index 2b9b6b00..90057048 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/gardes.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/gardes.ts @@ -1,9 +1,7 @@ import type { Constructor } from "./types/classes"; -const estElement = - (typeElement: Constructor) => - (element: unknown): element is T => - element instanceof typeElement; +const estElement = (typeElement: Constructor) => (element: unknown): element is T => + element instanceof typeElement; export const estHTMLSelectElement = estElement(HTMLSelectElement); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/messages.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/messages.ts index 49d411fe..41e39a2e 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/messages.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/messages.ts @@ -55,30 +55,31 @@ export const emetMessageMajContenuPanier = (args: MessageMajContenuPanierDonnees * @param message Le message émis. * @return void */ -export const emetUniqueMessageBroadcastChannel = (nomCanal: string, message: M): void => +export const emetUniqueMessageBroadcastChannel = (nomCanal: string, message: unknown): void => { pipe( new BroadcastChannel(nomCanal), - (canal) => canalPostMessage(canal, message), - (canal) => canal.close(), + canal => canalPostMessage(canal, message), + canal => canal.close(), ); +}; // Validations export const valideMessageMajBoutonPanier = ( evenementMessage: MessageEvent, ): Either, MessageMajBoutonPanier> => - Either.of, MessageMajBoutonPanier>( + Either.of>( parse(MessageMajBoutonPanierSchema, evenementMessage.data), - ).ifLeft((erreur) => reporteErreur(erreur)); + ).ifLeft(erreur => reporteErreur(erreur)); export const valideMessageMajContenuPanier = ( evenementMessage: MessageEvent, ): Either, MessageMajContenuPanier> => - Either.of, MessageMajContenuPanier>( + Either.of>( parse(MessageMajContenuPanierSchema, evenementMessage.data), - ).ifLeft((erreur) => reporteErreur(erreur)); + ).ifLeft(erreur => reporteErreur(erreur)); // Correspondances export const reponseEstCodeErreurWC = (reponse: SimplifiedResponse, codeErreurWC: string): boolean => safeSchemaParse(reponse, WCErrorSchema) - .map((v) => v.body.code === codeErreurWC) + .map(v => v.body.code === codeErreurWC) .orDefault(false); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/nombres.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/nombres.ts index a6207744..39a13ed6 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/nombres.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/nombres.ts @@ -5,10 +5,10 @@ export const estEntreDeuxNombres = (nombre: number, min: number, max: number): b export const diviseParCent = (nombre: number | string): number => Number(nombre) / 100; -export const arrondisADeuxDecimales = (nombre: number | string) => pipe(Number(nombre), (n) => n.toFixed(2)); +export const arrondisADeuxDecimales = (nombre: number | string) => pipe(Number(nombre), n => n.toFixed(2)); export const arrondisAZeroOuDeuxDecimales = (nombre: number | string): string => - pipe(Number(nombre), (n) => (n / Math.round(n) === 1 ? n.toFixed(0) : n.toFixed(2))); + pipe(Number(nombre), n => (n / Math.round(n) === 1 ? n.toFixed(0) : n.toFixed(2))); export const inverseNombre = (nombre: number | string): number => Number(nombre) * -1; diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/reseau.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/reseau.ts index 76e655c5..38e5dd62 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/reseau.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/reseau.ts @@ -38,7 +38,7 @@ type ArgumentsPostBackendWC = { // Fetch -export const getBackend = (args: ArgumentsGetBackendWC): Promise => +export const getBackend = async (args: ArgumentsGetBackendWC): Promise => fetch(args.route, { credentials: "same-origin", headers: { @@ -53,7 +53,7 @@ export const getBackend = (args: ArgumentsGetBackendWC): Promise => signal: AbortSignal.timeout(5000), }); -export const getBackendAvecParametresUrl = (args: ArgumentsGetBackendWC): Promise => +export const getBackendAvecParametresUrl = async (args: ArgumentsGetBackendWC): Promise => fetch(`${args.route}?${args.searchParams}`, { credentials: "same-origin", headers: { @@ -68,7 +68,7 @@ export const getBackendAvecParametresUrl = (args: ArgumentsGetBackendWC): Promis signal: AbortSignal.timeout(5000), }); -export const deleteBackend = (args: ArgumentsDeleteBackendWC): Promise => +export const deleteBackend = async (args: ArgumentsDeleteBackendWC): Promise => fetch(args.route, { credentials: "same-origin", headers: { @@ -83,7 +83,7 @@ export const deleteBackend = (args: ArgumentsDeleteBackendWC): Promise signal: AbortSignal.timeout(5000), }); -export const postBackend = (args: ArgumentsPostBackendWC): Promise => +export const postBackend = async (args: ArgumentsPostBackendWC): Promise => fetch(args.route, { body: args.corps, credentials: "same-origin", @@ -101,7 +101,7 @@ export const postBackend = (args: ArgumentsPostBackendWC): Promise => export const prefilledPostBackend = (nonce: string, authString?: string) => - (route: string, body: BodyInit, needsAuthString: boolean): Promise => + async (route: string, body: BodyInit, needsAuthString: boolean): Promise => fetch(route, { body: body, credentials: "same-origin", @@ -127,9 +127,9 @@ export const newPartialResponse = async (reponse: Response): Promise match(rs) - .with({ status: 400 }, () => new BadRequestError()) - .with({ status: 401 }, () => new UnauthorizedError()) - .with({ status: 403 }, () => new ForbiddenError()) - .with({ status: 404 }, () => new NotFoundError()) - .with({ status: 500 }, () => new ServerError()) - .otherwise((rs) => new Error(String(rs.status))); + ["with"]({ status: 400 }, () => new BadRequestError()) + ["with"]({ status: 401 }, () => new UnauthorizedError()) + ["with"]({ status: 403 }, () => new ForbiddenError()) + ["with"]({ status: 404 }, () => new NotFoundError()) + ["with"]({ status: 500 }, () => new ServerError()) + .otherwise(rs => new Error(String(rs.status))); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/safe-arrays.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/safe-arrays.ts index ea2288d5..75cd9850 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/safe-arrays.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/safe-arrays.ts @@ -7,7 +7,5 @@ import { Maybe } from "purify-ts"; */ export const first = (xs: Array): Maybe => Maybe.fromNullable(xs.at(0)); -export const find = - (predicateFn: (_1: T) => boolean) => - (xs: Array): Maybe => - Maybe.fromNullable(xs.find(predicateFn)); +export const find = (predicateFn: (_1: T) => boolean) => (xs: Array): Maybe => + Maybe.fromNullable(xs.find(predicateFn)); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/cart.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/cart.ts index f3ca2b81..1c76566c 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/cart.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/cart.ts @@ -20,24 +20,24 @@ export const WCStoreCartItemTotalsSchema = v.object({ }); export const WCStoreCartItemSchema = v.object({ - backorders_allowed: v.boolean(), - catalog_visibility: v.enum(CATALOG_VISIBILITIES), + backorders_allowed: v["boolean"](), + catalog_visibility: v["enum"](CATALOG_VISIBILITIES), description: v.string(), extensions: v.unknown(), id: v.number(), images: v.array(v.unknown()), item_data: v.array(v.unknown()), key: v.string(), - low_stock_remaining: v.union([v.number(), v.null()]), + low_stock_remaining: v.union([v.number(), v["null"]()]), name: v.string(), permalink: v.pipe(v.string(), v.url()), prices: v.unknown(), quantity: v.number(), quantity_limits: v.unknown(), short_description: v.string(), - show_backorder_badge: v.boolean(), + show_backorder_badge: v["boolean"](), sku: v.string(), - sold_individually: v.boolean(), + sold_individually: v["boolean"](), totals: WCStoreCartItemTotalsSchema, type: v.string(), variation: v.array(v.unknown()), @@ -60,10 +60,10 @@ export const WCStoreCartTotalsSchema = v.object({ total_items_tax: v.string(), total_price: v.pipe(v.union([v.string(), v.number()]), v.transform(Number)), total_shipping: v.pipe( - v.union([v.string(), v.number(), v.null()]), - v.transform((n) => (n ? Number(n) : 0)), + v.union([v.string(), v.number(), v["null"]()]), + v.transform(n => (n ? Number(n) : 0)), ), - total_shipping_tax: v.union([v.string(), v.null()]), + total_shipping_tax: v.union([v.string(), v["null"]()]), total_tax: v.string(), }); @@ -75,12 +75,12 @@ export const WCStoreCartSchema = v.object({ errors: v.unknown(), extensions: v.unknown(), fees: v.unknown(), - has_calculated_shipping: v.boolean(), + has_calculated_shipping: v["boolean"](), items: v.array(WCStoreCartItemSchema), items_count: v.pipe(v.number(), v.integer()), items_weight: v.pipe(v.number(), v.integer()), - needs_payment: v.boolean(), - needs_shipping: v.boolean(), + needs_payment: v["boolean"](), + needs_shipping: v["boolean"](), payment_methods: v.unknown(), payment_requirements: v.unknown(), shipping_address: WCStoreShippingAddressSchema, diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/couts-livraison.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/couts-livraison.ts index d842848b..025a9337 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/couts-livraison.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/couts-livraison.ts @@ -26,7 +26,7 @@ export const WCStoreShippingRateShippingRateSchema = v.object({ name: v.string(), price: v.pipe(v.union([v.string(), v.number()]), v.transform(Number)), rate_id: v.string(), - selected: v.boolean(), + selected: v["boolean"](), taxes: v.string(), }); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/erreurs.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/erreurs.ts index e1ab8a90..01e47482 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/erreurs.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/erreurs.ts @@ -24,14 +24,14 @@ export const WCAddressErrorSchema = v.object({ billing: v.optional( v.object({ code: v.string(), - data: v.union([v.null(), v.string()]), + data: v.union([v["null"](), v.string()]), message: v.string(), }), ), shipping: v.optional( v.object({ code: v.string(), - data: v.union([v.null(), v.string()]), + data: v.union([v["null"](), v.string()]), message: v.string(), }), ), diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/products.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/products.ts index 7f7369aa..f6f99f1f 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/products.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/products.ts @@ -17,36 +17,36 @@ import { export const WCProductsArgsSchema = v.object({ // Date ISO8601 after: v.optional(v.optional(v.string())), - attribute_relation: v.optional(v.enum(ATTRIBUTES_RELATIONS)), + attribute_relation: v.optional(v["enum"](ATTRIBUTES_RELATIONS)), attributes: v.optional(v.array(v.unknown())), // Date ISO8601 before: v.optional(v.string()), - catalog_visibility: v.optional(v.enum(CATALOG_VISIBILITIES)), + catalog_visibility: v.optional(v["enum"](CATALOG_VISIBILITIES)), category: v.optional(v.string()), - category_operator: v.optional(v.enum(CATEGORY_OPERATORS)), - context: v.optional(v.enum(PRODUCTS_CONTEXTES)), - date_column: v.optional(v.enum(DATE_COLUMN_VALUES)), + category_operator: v.optional(v["enum"](CATEGORY_OPERATORS)), + context: v.optional(v["enum"](PRODUCTS_CONTEXTES)), + date_column: v.optional(v["enum"](DATE_COLUMN_VALUES)), exclude: v.optional(v.array(v.pipe(v.number(), v.integer()))), - featured: v.optional(v.boolean()), + featured: v.optional(v["boolean"]()), include: v.optional(v.array(v.pipe(v.number(), v.integer()))), max_price: v.optional(v.string()), min_price: v.optional(v.string()), offset: v.optional(v.number()), - on_sale: v.optional(v.boolean()), - order: v.optional(v.enum(ORDER_VALUES)), - orderby: v.optional(v.enum(ORDERBY_VALUES)), + on_sale: v.optional(v["boolean"]()), + order: v.optional(v["enum"](ORDER_VALUES)), + orderby: v.optional(v["enum"](ORDERBY_VALUES)), page: v.optional(v.pipe(v.number(), v.minValue(1))), parent: v.optional(v.array(v.pipe(v.number(), v.integer()))), parent_exclude: v.optional(v.array(v.pipe(v.number(), v.integer()))), per_page: v.optional(v.pipe(v.number(), v.minValue(0), v.maxValue(100))), - rating: v.optional(v.array(v.enum(RATINGS))), + rating: v.optional(v.array(v["enum"](RATINGS))), search: v.optional(v.string()), sku: v.optional(v.string()), slug: v.optional(v.string()), - stock_status: v.optional(v.array(v.enum(STOCK_STATUSES))), + stock_status: v.optional(v.array(v["enum"](STOCK_STATUSES))), tag: v.optional(v.string()), - tag_operator: v.optional(v.enum(TAG_OPERATORS)), - type: v.optional(v.enum(PRODUCT_TYPES)), + tag_operator: v.optional(v["enum"](TAG_OPERATORS)), + type: v.optional(v["enum"](PRODUCT_TYPES)), }); export const WCProductSchema = v.object({ @@ -70,7 +70,7 @@ export const WCProductSchema = v.object({ ), description: v.string(), extensions: v.unknown(), - has_options: v.boolean(), + has_options: v["boolean"](), id: v.number(), images: v.array( v.object({ @@ -83,12 +83,12 @@ export const WCProductSchema = v.object({ thumbnail: v.string(), }), ), - is_in_stock: v.boolean(), - is_on_backorder: v.boolean(), - is_purchasable: v.boolean(), - low_stock_remaining: v.union([v.number(), v.null()]), + is_in_stock: v["boolean"](), + is_on_backorder: v["boolean"](), + is_purchasable: v["boolean"](), + low_stock_remaining: v.union([v.number(), v["null"]()]), name: v.string(), - on_sale: v.boolean(), + on_sale: v["boolean"](), parent: v.number(), permalink: v.string(), price_html: v.string(), @@ -109,7 +109,7 @@ export const WCProductSchema = v.object({ short_description: v.string(), sku: v.string(), slug: v.string(), - sold_individually: v.boolean(), + sold_individually: v["boolean"](), tags: v.array(v.string()), type: v.string(), variation: v.unknown(), diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/v3/orders.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/v3/orders.ts index 635bfd2a..16da01f8 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/v3/orders.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/v3/orders.ts @@ -14,7 +14,7 @@ export const WCV3OrdersCouponLineSchema = v.object({ discount: v.string(), discount_tax: v.string(), discount_type: v.string(), - free_shipping: v.boolean(), + free_shipping: v["boolean"](), id: v.pipe(v.number(), v.integer()), meta_data: v.array(WCV3OrdersCouponLineMetaDataSchema), nominal_amount: v.number(), @@ -37,7 +37,7 @@ export const WCV3OrdersFeeLineSchema = v.object({ meta_data: v.array(WCV3OrdersFeeLineMetaDataSchema), name: v.string(), tax_class: v.string(), - tax_status: v.enum(TAX_STATUSES), + tax_status: v["enum"](TAX_STATUSES), taxes: v.array(WCV3OrdersFeeLineTaxSchema), total: v.string(), total_tax: v.string(), @@ -88,7 +88,7 @@ export const WCV3OrdersLineItemSchema = v.object({ image: v.optional(WCV3OrdersLineItemImageSchema), meta_data: v.optional(v.array(WCV3OrdersLineItemMetaDataSchema)), name: v.optional(v.string()), - parent_name: v.optional(v.union([v.string(), v.null()])), + parent_name: v.optional(v.union([v.string(), v["null"]()])), price: v.optional(v.number()), product_id: v.optional(v.pipe(v.number(), v.integer())), quantity: v.optional(v.pipe(v.number(), v.integer())), @@ -116,14 +116,14 @@ export const WCV3OrdersArgsSchema = v.object({ customer_note: v.optional(v.string()), fee_lines: v.optional(v.array(WCV3OrdersFeeLineSchema)), line_items: v.optional(v.array(WCV3OrdersLineItemSchema)), - manual_update: v.optional(v.boolean()), + manual_update: v.optional(v["boolean"]()), parent_id: v.optional(v.pipe(v.number(), v.integer())), payment_method: v.optional(v.string()), payment_method_title: v.optional(v.string()), - set_paid: v.optional(v.boolean()), + set_paid: v.optional(v["boolean"]()), shipping: v.optional(WCStoreShippingAddressSchema), shipping_lines: v.optional(v.array(WCV3OrdersShippingLineSchema)), - status: v.optional(v.enum(ORDER_STATUSES)), + status: v.optional(v["enum"](ORDER_STATUSES)), transaction_id: v.optional(v.string()), }); @@ -139,37 +139,37 @@ export const WCV3OrderSchema = v.object({ customer_ip_address: v.string(), customer_note: v.string(), customer_user_agent: v.string(), - date_completed: v.union([v.string(), v.null()]), - date_completed_gmt: v.union([v.string(), v.null()]), + date_completed: v.union([v.string(), v["null"]()]), + date_completed_gmt: v.union([v.string(), v["null"]()]), // Date date_created: v.string(), date_created_gmt: v.string(), date_modified: v.string(), date_modified_gmt: v.string(), - date_paid: v.union([v.string(), v.null()]), - date_paid_gmt: v.union([v.string(), v.null()]), + date_paid: v.union([v.string(), v["null"]()]), + date_paid_gmt: v.union([v.string(), v["null"]()]), discount_tax: v.string(), discount_total: v.string(), fee_lines: v.array(WCV3OrdersFeeLineSchema), id: v.pipe(v.number(), v.integer()), - is_editable: v.boolean(), + is_editable: v["boolean"](), line_items: v.array(WCV3OrdersLineItemSchema), meta_data: v.unknown(), - needs_payment: v.boolean(), - needs_processing: v.boolean(), + needs_payment: v["boolean"](), + needs_processing: v["boolean"](), number: v.string(), order_key: v.string(), parent_id: v.pipe(v.number(), v.integer()), payment_method: v.string(), payment_method_title: v.string(), payment_url: v.string(), - prices_include_tax: v.boolean(), + prices_include_tax: v["boolean"](), refunds: v.array(v.unknown()), shipping: WCStoreShippingAddressSchema, shipping_lines: v.array(WCV3OrdersShippingLineSchema), shipping_tax: v.string(), shipping_total: v.string(), - status: v.enum(ORDER_STATUSES), + status: v["enum"](ORDER_STATUSES), tax_lines: v.array(v.unknown()), total: v.string(), total_tax: v.string(), diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/v3/products.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/v3/products.ts index 6e0b8b52..0f1158cd 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/v3/products.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/api/v3/products.ts @@ -21,20 +21,20 @@ export const WCV3ProductsArgsSchema = v.object({ // Date ISO8601 after: v.optional(v.string()), attribute: v.optional(v.string()), - attribute_relation: v.optional(v.enum(ATTRIBUTES_RELATIONS)), + attribute_relation: v.optional(v["enum"](ATTRIBUTES_RELATIONS)), attribute_term: v.optional(v.string()), attributes: v.optional(v.array(v.unknown())), // Date ISO8601 before: v.optional(v.string()), - catalog_visibility: v.optional(v.enum(CATALOG_VISIBILITIES)), + catalog_visibility: v.optional(v["enum"](CATALOG_VISIBILITIES)), category: v.optional(v.string()), - category_operator: v.optional(v.enum(CATEGORY_OPERATORS)), - context: v.optional(v.enum(PRODUCTS_CONTEXTES)), - date_column: v.optional(v.enum(DATE_COLUMN_VALUES)), - dates_are_gmt: v.optional(v.boolean()), + category_operator: v.optional(v["enum"](CATEGORY_OPERATORS)), + context: v.optional(v["enum"](PRODUCTS_CONTEXTES)), + date_column: v.optional(v["enum"](DATE_COLUMN_VALUES)), + dates_are_gmt: v.optional(v["boolean"]()), exclude: v.optional(v.array(v.pipe(v.number(), v.integer()))), exclude_meta: v.optional(v.array(v.string())), - featured: v.optional(v.boolean()), + featured: v.optional(v["boolean"]()), include: v.optional(v.array(v.pipe(v.number(), v.integer()))), include_meta: v.optional(v.array(v.string())), max_price: v.optional(v.string()), @@ -44,24 +44,24 @@ export const WCV3ProductsArgsSchema = v.object({ // Date ISO8601 modified_before: v.optional(v.string()), offset: v.optional(v.pipe(v.number(), v.integer())), - on_sale: v.optional(v.boolean()), - order: v.optional(v.enum(ORDER_VALUES)), - orderby: v.optional(v.enum(ORDERBY_VALUES)), + on_sale: v.optional(v["boolean"]()), + order: v.optional(v["enum"](ORDER_VALUES)), + orderby: v.optional(v["enum"](ORDERBY_VALUES)), page: v.optional(v.pipe(v.number(), v.minValue(1))), parent: v.optional(v.array(v.pipe(v.number(), v.integer()))), parent_exclude: v.optional(v.array(v.pipe(v.number(), v.integer()))), per_page: v.optional(v.pipe(v.number(), v.minValue(0), v.maxValue(100))), - rating: v.optional(v.array(v.enum(RATINGS))), + rating: v.optional(v.array(v["enum"](RATINGS))), search: v.optional(v.string()), search_sku: v.optional(v.string()), shipping_class: v.optional(v.string()), sku: v.optional(v.string()), slug: v.optional(v.string()), - status: v.optional(v.enum(PRODUCT_STATUTES)), - stock_status: v.optional(v.array(v.enum(STOCK_STATUSES))), + status: v.optional(v["enum"](PRODUCT_STATUTES)), + stock_status: v.optional(v.array(v["enum"](STOCK_STATUSES))), tag: v.optional(v.string()), - tag_operator: v.optional(v.enum(TAG_OPERATORS)), - type: v.optional(v.enum(PRODUCT_TYPES)), + tag_operator: v.optional(v["enum"](TAG_OPERATORS)), + type: v.optional(v["enum"](PRODUCT_TYPES)), }); export const WCV3ProductDownloadsSchema = v.object({ @@ -99,8 +99,8 @@ export const WCV3ProductAttributeSchema = v.object({ name: v.string(), options: v.array(v.string()), position: v.pipe(v.number(), v.integer()), - variation: v.boolean(), - visible: v.boolean(), + variation: v["boolean"](), + visible: v["boolean"](), }); export const WCV3ProductDefaultAttributeSchema = v.object({ id: v.pipe(v.number(), v.integer()), @@ -116,46 +116,46 @@ export const WCV3ProductMetaDataSchema = v.object({ export const WCV3ProductSchema = v.object({ attributes: v.array(WCV3ProductAttributeSchema), average_rating: v.string(), - backordered: v.boolean(), - backorders: v.enum(BACKORDERS_SETTINGS), - backorders_allowed: v.boolean(), + backordered: v["boolean"](), + backorders: v["enum"](BACKORDERS_SETTINGS), + backorders_allowed: v["boolean"](), button_text: v.string(), - catalog_visibility: v.enum(CATALOG_VISIBILITIES), + catalog_visibility: v["enum"](CATALOG_VISIBILITIES), categories: v.array(WCV3ProductCategorySchema), cross_sell_ids: v.array(v.pipe(v.number(), v.integer())), date_created: v.string(), date_created_gmt: v.string(), date_modified: v.string(), date_modified_gmt: v.string(), - date_on_sale_from: v.union([v.string(), v.null()]), - date_on_sale_from_gmt: v.union([v.string(), v.null()]), - date_on_sale_to: v.union([v.string(), v.null()]), - date_on_sale_to_gmt: v.union([v.string(), v.null()]), + date_on_sale_from: v.union([v.string(), v["null"]()]), + date_on_sale_from_gmt: v.union([v.string(), v["null"]()]), + date_on_sale_to: v.union([v.string(), v["null"]()]), + date_on_sale_to_gmt: v.union([v.string(), v["null"]()]), default_attributes: v.array(WCV3ProductDefaultAttributeSchema), description: v.string(), dimensions: WCV3ProductDimensionsSchema, download_expiry: v.number(), download_limit: v.number(), - downloadable: v.boolean(), + downloadable: v["boolean"](), downloads: v.array(WCV3ProductDownloadsSchema), external_url: v.string(), - featured: v.boolean(), + featured: v["boolean"](), generated_slug: v.optional(v.string()), global_unique_id: v.string(), grouped_products: v.array(v.pipe(v.number(), v.integer())), - has_options: v.boolean(), + has_options: v["boolean"](), id: v.pipe(v.number(), v.integer()), // NOTE: Ajouté par mes soins - image_repos: v.union([v.string(), v.null()]), + image_repos: v.union([v.string(), v["null"]()]), // NOTE: Ajouté par mes soins - image_survol: v.union([v.string(), v.null()]), + image_survol: v.union([v.string(), v["null"]()]), images: v.array(WCV3ProductImageSchema), - low_stock_amount: v.union([v.number(), v.null()]), - manage_stock: v.boolean(), + low_stock_amount: v.union([v.number(), v["null"]()]), + manage_stock: v["boolean"](), menu_order: v.pipe(v.number(), v.integer()), meta_data: v.array(WCV3ProductMetaDataSchema), name: v.string(), - on_sale: v.boolean(), + on_sale: v["boolean"](), parent_id: v.pipe(v.number(), v.integer()), permalink: v.pipe(v.string(), v.url()), permalink_template: v.optional(v.string()), @@ -163,32 +163,32 @@ export const WCV3ProductSchema = v.object({ price: v.string(), price_html: v.string(), prix_maximal: v.string(), - purchasable: v.boolean(), + purchasable: v["boolean"](), purchase_note: v.string(), rating_count: v.pipe(v.number(), v.integer()), regular_price: v.string(), related_ids: v.array(v.pipe(v.number(), v.integer())), - reviews_allowed: v.boolean(), + reviews_allowed: v["boolean"](), sale_price: v.string(), shipping_class: v.string(), shipping_class_id: v.pipe(v.number(), v.integer()), - shipping_required: v.boolean(), - shipping_taxable: v.boolean(), + shipping_required: v["boolean"](), + shipping_taxable: v["boolean"](), short_description: v.string(), sku: v.string(), slug: v.string(), - sold_individually: v.boolean(), - status: v.enum(PRODUCT_STATUTES), - stock_quantity: v.union([v.number(), v.null()]), - stock_status: v.enum(STOCK_STATUSES), + sold_individually: v["boolean"](), + status: v["enum"](PRODUCT_STATUTES), + stock_quantity: v.union([v.number(), v["null"]()]), + stock_status: v["enum"](STOCK_STATUSES), tags: v.array(WCV3ProductTagSchema), tax_class: v.string(), - tax_status: v.enum(TAX_STATUTES), + tax_status: v["enum"](TAX_STATUTES), total_sales: v.pipe(v.number(), v.integer()), - type: v.enum(PRODUCT_TYPES), + type: v["enum"](PRODUCT_TYPES), upsell_ids: v.array(v.pipe(v.number(), v.integer())), variations: v.array(v.pipe(v.number(), v.integer())), - virtual: v.boolean(), + virtual: v["boolean"](), weight: v.string(), }); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/messages.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/messages.ts index 6552dd86..5b24c6c7 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/messages.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/schemas/messages.ts @@ -5,7 +5,7 @@ import * as v from "valibot"; import { TYPES_MESSAGES } from "../../constantes/messages.ts"; import { WCStoreCartItemSchema } from "./api/cart.ts"; -export const TypesMessagesSchema = v.enum(TYPES_MESSAGES); +export const TypesMessagesSchema = v["enum"](TYPES_MESSAGES); export const MessageMajBoutonPanierDonneesSchema = v.object({ quantiteProduits: v.number(), diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/session-storage.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/session-storage.ts index e6597b2c..bc2b13bb 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/session-storage.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/session-storage.ts @@ -35,4 +35,4 @@ export const getSessionStorageByKey = (key: string, sch export const setSessionStorageByKey = (key: string, schema: S) => (value: unknown): Either, InferOutput> => - safeSchemaParse(value, schema).chain((v) => eitherSetSessionStorage(key, v)); + safeSchemaParse(value, schema).chain(v => eitherSetSessionStorage(key, v)); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/types/classes.d.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/types/classes.d.ts index d800979a..00d67997 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/types/classes.d.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/types/classes.d.ts @@ -1 +1 @@ -export type Constructor = new (...args: Array) => T; +export type Constructor = new(...args: Array) => T; diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/utils.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/utils.ts index 49b3b12b..25660470 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/utils.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/utils.ts @@ -7,9 +7,7 @@ import { CleNonTrouveError } from "./erreurs"; /** * TODO */ -export const propEither = - (cle: K) => - (donnees: T): Either => - Maybe.fromNullable(D.getUnsafe(donnees, cle)).toEither( - new CleNonTrouveError(`La clé « ${String(cle)} » n'a pas été trouvé dans l'objet.`), - ); +export const propEither = (cle: K) => (donnees: T): Either => + Maybe.fromNullable(D.getUnsafe(donnees, cle)).toEither( + new CleNonTrouveError(`La clé « ${String(cle)} » n'a pas été trouvé dans l'objet.`), + ); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/lib/validation.ts b/web/app/themes/haiku-atelier-2024/src/scripts/lib/validation.ts index 42141e52..4387e2a2 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/lib/validation.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/lib/validation.ts @@ -12,6 +12,5 @@ export const safeSchemaParse = ( ): Either, InferOutput> => Either.encase(() => parse(schema, valeur)); export const safeSchemaParseCurried = - (schema: S) => - (valeur: unknown): Either, InferOutput> => + (schema: S) => (valeur: unknown): Either, InferOutput> => Either.encase(() => parse(schema, valeur)); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-adresses.ts b/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-adresses.ts index a96b04a6..48fbebe4 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-adresses.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-adresses.ts @@ -8,15 +8,16 @@ import { ValiError } from "valibot"; import type { AnySchema } from "valibot"; import type { WCStoreBillingAddress, WCStoreShippingAddress } from "../lib/types/api/adresses.ts"; -import type { WCStoreCart, WCStoreShippingRate, WCStoreShippingRateShippingRate } from "../lib/types/api/cart.ts"; import type { WCStoreCartUpdateCustomerArgs } from "../lib/types/api/cart-update-customer.ts"; +import type { WCStoreCart, WCStoreShippingRate, WCStoreShippingRateShippingRate } from "../lib/types/api/cart.ts"; import type { WCV3Order, WCV3OrdersArgs } from "../lib/types/api/v3/orders.ts"; import type { GenericPageState } from "../lib/types/pages.ts"; import type { FetchErrors, HttpCodeErrors } from "../lib/types/reseau.ts"; +import { Console, Effect, Stream } from "effect"; +import { ReadonlyRecord } from "effect/Record"; import { ROUTE_API_MAJ_CLIENT, ROUTE_API_NOUVELLE_COMMANDES } from "../constantes/api.ts"; import { ATTRIBUT_CHARGEMENT, ATTRIBUT_LIVRAISON_VALIDEE } from "../constantes/dom.ts"; -import { NOM_CANAL_REVALIDATION_LIVRAISON } from "../constantes/messages.ts"; import { ERREUR_ADRESSE_GENERIQUE, ERREUR_ADRESSE_MAUVAIS_CODE_POSTAL, @@ -24,6 +25,7 @@ import { ERREUR_GENERIQUE_RESEAU, ERREUR_GENERIQUE_SOUMISSION_ADRESSES, } from "../constantes/messages-utilisateur.ts"; +import { NOM_CANAL_REVALIDATION_LIVRAISON } from "../constantes/messages.ts"; import { estErreurFetch, estErreurHttp, setButtonLoadingState } from "../lib/dom.ts"; import { reporteEtJournaliseErreur } from "../lib/erreurs.ts"; import { ErreurAdresseInvalide } from "../lib/erreurs/adresses.ts"; @@ -36,15 +38,13 @@ import { emetUniqueMessageBroadcastChannel } from "../lib/messages.ts"; import { diviseParCent } from "../lib/nombres.ts"; import { newPartialResponse, prefilledPostBackend, safeFetch, traiteErreursBackendWooCommerce } from "../lib/reseau.ts"; import { find, first } from "../lib/safe-arrays.ts"; -import { WCStoreCartSchema } from "../lib/schemas/api/cart.ts"; import { WCStoreCartUpdateCustomerArgsSchema } from "../lib/schemas/api/cart-update-customer.ts"; +import { WCStoreCartSchema } from "../lib/schemas/api/cart.ts"; import { estWCAddressError } from "../lib/schemas/api/erreurs.ts"; import { WCV3OrdersArgsSchema, WCV3OrderSchema } from "../lib/schemas/api/v3/orders.ts"; import { safeSchemaParse } from "../lib/validation.ts"; import { E } from "./scripts-page-panier-elements.ts"; import { getShippingRatesLS } from "./scripts-page-panier-local-storage.ts"; -import { ReadonlyRecord } from "effect/Record"; -import { Console, Effect, Stream } from "effect"; type Addresses = { billing_address: WCStoreBillingAddress; @@ -60,7 +60,7 @@ const postBackend = prefilledPostBackend(ETATS_PAGE.nonce, ETATS_PAGE.authString * * @returns Un `Effect` ne retournant rien et ne pouvant échouer. */ -export const initCartFormEventEmitters = Effect.fn("initCartFormEventEmitters")(function* () { +export const initCartFormEventEmitters = Effect.fn("initCartFormEventEmitters")(function*() { return yield* pipe( Stream.fromEventListener(E.FORMULAIRE_PANIER, "change"), Stream.tap((event: Event) => { @@ -125,7 +125,7 @@ export const initShippingCalculationButton = (): void => { .fromFalsy(E.FORMULAIRE_PANIER.checkValidity()) // Ne fais rien si la livraison a déjà été validée .chainNullable((): boolean | undefined => - E.BOUTON_ACTIONS_FORMULAIRE.hasAttribute(ATTRIBUT_LIVRAISON_VALIDEE) ? undefined : true, + E.BOUTON_ACTIONS_FORMULAIRE.hasAttribute(ATTRIBUT_LIVRAISON_VALIDEE) ? undefined : true ) .ifJust((): void => { event.preventDefault(); @@ -133,8 +133,8 @@ export const initShippingCalculationButton = (): void => { /** Les données du Formulaire transformées pour la requête vers le Backend. */ const formArgs: WCStoreCartUpdateCustomerArgs = pipe( Object.fromEntries(new FormData(E.FORMULAIRE_PANIER)) as Record, - (fields) => dictMap(fields, stringTrim), - (fields) => getAddressesFromForm(fields, E.BOUTON_SEPARATION_ADRESSES.checked), + fields => dictMap(fields, stringTrim), + fields => getAddressesFromForm(fields, E.BOUTON_SEPARATION_ADRESSES.checked), ); // Réalise la requête et traite sa réponse @@ -142,7 +142,7 @@ export const initShippingCalculationButton = (): void => { // Désactive le Bouton pour empêcher des requêtes concurrentes .ifRight((): void => setButtonLoadingState(E.BOUTON_ACTIONS_FORMULAIRE, true)) .chain((args: WCStoreCartUpdateCustomerArgs) => - safeFetch(postBackend(ROUTE_API_MAJ_CLIENT, JSON.stringify(args), false)), + safeFetch(postBackend(ROUTE_API_MAJ_CLIENT, JSON.stringify(args), false)) ) .chain((rs: Response) => EitherAsync( @@ -151,18 +151,18 @@ export const initShippingCalculationButton = (): void => { .with({ status: 200 }, (rs): unknown => rs.body) .with( { - body: P.when((body) => estWCAddressError(body)), + body: P.when(body => estWCAddressError(body)), status: 400, }, (rs): never => throwE(new ErreurAdresseInvalide(rs.body.data.params)), ) .otherwise((rs): never => throwE(traiteErreursBackendWooCommerce(rs))), - ), + ) ) .chain((b: unknown) => EitherAsync.liftEither(safeSchemaParse(b, WCStoreCartSchema))) .ifRight((cart: WCStoreCart): void => { /** La méthode de livraison sélectionnée dans le SessionStorage */ - const oldSelectedRateLS = getShippingRatesLS().chain(find((sr) => sr.selected)); + const oldSelectedRateLS = getShippingRatesLS().chain(find(sr => sr.selected)); /* Les méthodes de livraison mises à jour avec le nouveau choix de l'Utilisateur. */ const updatedRates = first(cart.shipping_rates) @@ -171,7 +171,7 @@ export const initShippingCalculationButton = (): void => { srs.map((sr: WCStoreShippingRateShippingRate, index: number) => { // Sélectionne la nouvelle méthode demandée OU la première si le SessionStorage n'a pas été défini oldSelectedRateLS.caseOf({ - Just: (sm) => { + Just: sm => { sr.selected = sr.method_id === sm.method_id; }, Nothing: () => { @@ -183,7 +183,7 @@ export const initShippingCalculationButton = (): void => { sr.price = diviseParCent(sr.price); return sr; - }), + }) ) .orDefault([]); @@ -191,13 +191,14 @@ export const initShippingCalculationButton = (): void => { window.dispatchEvent(createUpdatedShippingRatesEvent(updatedRates, true)); // Met à jour les Totaux - const newShippingPrice = updatedRates.find((m) => m.selected)?.price ?? 0; + const newShippingPrice = updatedRates.find(m => m.selected)?.price ?? 0; const newTotals = { ...cart.totals, total_discount: diviseParCent(cart.totals.total_discount), total_items: diviseParCent(cart.totals.total_items), - total_price: - diviseParCent(cart.totals.total_items) - diviseParCent(cart.totals.total_discount) + newShippingPrice, + total_price: diviseParCent(cart.totals.total_items) + - diviseParCent(cart.totals.total_discount) + + newShippingPrice, total_shipping: newShippingPrice, }; @@ -222,10 +223,10 @@ export const initShippingCalculationButton = (): void => { match(e.problemes) .when( // TODO: Créer une fonction utilitaire - (p) => + p => pipe( dictValues(p), - arrayFind((c) => c === "The provided postcode is not valid"), + arrayFind(c => c === "The provided postcode is not valid"), ), // TODO: Créer une fonction utilitaire pour fixer le texte d'un message (): void => { @@ -315,14 +316,14 @@ export const initOrderCreationButton = (): void => { }; // Retire toute méthode de livraison invalide. - formArgs.shipping_lines = formArgs.shipping_lines.filter((line) => line.method_id !== undefined); + formArgs.shipping_lines = formArgs.shipping_lines.filter(line => line.method_id !== undefined); // Réalise la requête et traite sa réponse void EitherAsync.liftEither(safeSchemaParse(formArgs, WCV3OrdersArgsSchema)) // Désactive le Bouton pour empêcher des requêtes concurrentes .ifRight((): void => setButtonLoadingState(E.BOUTON_ACTIONS_FORMULAIRE, true)) .chain((args: WCV3OrdersArgs) => - safeFetch(postBackend(ROUTE_API_NOUVELLE_COMMANDES, JSON.stringify(args), true)), + safeFetch(postBackend(ROUTE_API_NOUVELLE_COMMANDES, JSON.stringify(args), true)) ) .chain((rs: Response) => EitherAsync( @@ -330,7 +331,7 @@ export const initOrderCreationButton = (): void => { match(await newPartialResponse(rs)) .with({ status: 201 }, (rs): unknown => rs.body) .otherwise((rs): never => throwE(traiteErreursBackendWooCommerce(rs))), - ), + ) ) .chain((b: unknown) => EitherAsync.liftEither(safeSchemaParse(b, WCV3OrderSchema))) .ifRight((order: WCV3Order): void => { @@ -342,9 +343,9 @@ export const initOrderCreationButton = (): void => { // Redirige vers Stripe Maybe.fromNullable(new URL(`https://${window.location.host}/checkout`)) - .ifJust((url) => url.searchParams.append("order_key", order.order_key)) - .ifJust((url) => url.searchParams.append("order_id", String(order.id))) - .ifJust((url) => location.assign(url)); + .ifJust(url => url.searchParams.append("order_key", order.order_key)) + .ifJust(url => url.searchParams.append("order_id", String(order.id))) + .ifJust(url => location.assign(url)); }) .ifLeft((err: FetchErrors | HttpCodeErrors | ValiError): void => { match(err) diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-code-promo.ts b/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-code-promo.ts index f37e0298..1b877b75 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-code-promo.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-code-promo.ts @@ -54,193 +54,34 @@ export const initialiseElementsCodePromo = (): void => { codePromoPresent: recuperePresenceCodePromo(), valeurCodePromo: recupereValeurCodePromo(), }) - // Un code promo doit être ajouté - // Aucun code promo n'est déjà présent et une valeur acceptable existe - .with( + [ + // Un code promo doit être ajouté + // Aucun code promo n'est déjà présent et une valeur acceptable existe + "with" + ]( { cible: P.when((cible: EventTarget | null) => - targetMatchesSelector(cible, DOM_BOUTON_CODE_PROMO), + targetMatchesSelector(cible, DOM_BOUTON_CODE_PROMO) ), codePromoPresent: false, valeurCodePromo: P.string, }, - ({ valeurCodePromo }) => - void EitherAsync - // Vérifie le Schéma des arguments - .liftEither(safeSchemaParse({ code: valeurCodePromo }, WCStoreCartApplyCouponArgsSchema)) - .ifRight(() => { - // Désactive le Bouton pour empêcher des requêtes concurrentes - E.BOUTON_CODE_PROMO.setAttribute(ATTRIBUT_DESACTIVE, ""); - E.BOUTON_CODE_PROMO.setAttribute(ATTRIBUT_CHARGEMENT, ""); - // Réinitialise le Message à l'Utilisateur - E.MESSAGE_CODE_PROMO.textContent = ""; - - // Lance un cycle d'animation sur le texte de chargement - lanceAnimationCycleLoading(E.BOUTON_CODE_PROMO, 500); - }) - // Réalise la requête auprès du backend - .map((args: WCStoreCartApplyCouponArgs) => - postBackend({ - corps: JSON.stringify(args), - nonce: ETATS_PAGE.nonce, - route: ROUTE_API_APPLIQUE_COUPON, - }), - ) - // Traite les cas d'Erreur - .chain((reponse: Response) => - EitherAsync(async ({ throwE }) => { - const reponseSimplifiee: SimplifiedResponse = { - body: await reponse.json(), - status: reponse.status, - }; - - return match(reponseSimplifiee) - .with({ status: 500 }, () => throwE(new ServerError("500 Server Error"))) - .with( - { - body: P.when(() => reponseEstCodeErreurWC(reponseSimplifiee, ERREUR_CODE_PROMO_INVALIDE)), - status: 400, - }, - () => throwE(new ErreurCodePromoInvalide(recupereValeurCodePromo() ?? "")), - ) - .with({ status: 200 }, () => reponseSimplifiee.body) - .run(); - }), - ) - // Vérifie le Schéma de la Réponse du backend - .chain((corpsReponse: unknown) => EitherAsync.liftEither(safeSchemaParse(corpsReponse, WCStoreCartSchema))) - // Déclenche les mises à jour du DOM avec les données du nouveau Panier - .ifRight((panier: WCStoreCart) => { - E.ENSEMBLE_CODE_PROMO.toggleAttribute(ATTRIBUT_CODE_PROMO_PRESENT); - E.CHAMP_CODE_PROMO.toggleAttribute(ATTRIBUT_DESACTIVE); - E.CHAMP_CODE_PROMO.value = panier.coupons[0]?.code ?? ""; - E.BOUTON_CODE_PROMO.textContent = "Remove"; - - E.TOTAL_PANIER.textContent = pipe( - diviseParCent(panier.totals.total_price), - arrondisADeuxDecimales, - formateEnEuros, - ); - E.TOTAL_REDUCTION_LIGNE.toggleAttribute(ATTRIBUT_HIDDEN); - E.TOTAL_REDUCTION_VALEUR.textContent = pipe( - diviseParCent(panier.totals.total_discount), - inverseNombre, - arrondisADeuxDecimales, - formateEnEuros, - ); - - window.dispatchEvent(CODE_PROMO_MAJ_EVENT); - // EmetUniqueMessageBroadcastChannel(NOM_CANAL_REVALIDATION_LIVRAISON, true); - }) - .ifLeft((erreur) => { - // Rétablis le texte d'origine - E.BOUTON_CODE_PROMO.textContent = "Apply"; - - // Traite les Erreurs et affiche un Message à l'Utilisateur - match(erreur) - .with(P.instanceOf(ValiError), (e) => { - reporteErreur(e); - console.error("ValiError", e.issues); - }) - .with(P.instanceOf(ErreurCodePromoInvalide), (e) => { - E.MESSAGE_CODE_PROMO.textContent = "This promo code does not exist."; - reporteErreur(e); - console.error(e); - }) - .with(P.instanceOf(ServerError), (e) => { - E.MESSAGE_CODE_PROMO.textContent = - "Sorry, something went wrong! Please refresh the page and try again."; - reporteErreur(e); - console.error(e); - }) - .with(P.instanceOf(TypeError), (e) => { - E.MESSAGE_CODE_PROMO.textContent = - "Sorry, something went wrong! Please refresh the page and try again."; - reporteErreur(e); - console.error(e); - }) - .exhaustive(); - }) - .finally(() => { - // Désactive l'animation de chargement et rend le Bouton de nouveau cliquable - // TODO: Créer un type d'Événement ? - E.BOUTON_CODE_PROMO.removeAttribute(ATTRIBUT_CHARGEMENT); - E.BOUTON_CODE_PROMO.removeAttribute(ATTRIBUT_DESACTIVE); - }) - .run(), + ({ valeurCodePromo }) => undefined, ) - // Un code promo doit être retiré - // Un code promo est présent sous forme de chaîne - .with( + [ + // Un code promo doit être retiré + // Un code promo est présent sous forme de chaîne + "with" + ]( { - cible: P.when((cible) => targetMatchesSelector(cible, DOM_BOUTON_CODE_PROMO)), + cible: P.when(cible => targetMatchesSelector(cible, DOM_BOUTON_CODE_PROMO)), codePromoPresent: true, valeurCodePromo: P.string, }, - ({ valeurCodePromo }) => - void EitherAsync.liftEither(safeSchemaParse({ code: valeurCodePromo }, WCStoreCartRemoveCouponArgsSchema)) - .ifRight(() => { - E.BOUTON_CODE_PROMO.setAttribute(ATTRIBUT_DESACTIVE, ""); - E.BOUTON_CODE_PROMO.setAttribute(ATTRIBUT_CHARGEMENT, ""); - - lanceAnimationCycleLoading(E.BOUTON_CODE_PROMO, 500); - }) - .map((args: WCStoreCartRemoveCouponArgs) => - postBackend({ - corps: JSON.stringify(args), - nonce: ETATS_PAGE.nonce, - route: ROUTE_API_RETIRE_COUPON, - }), - ) - .chain((reponse: Response) => - EitherAsync(async ({ throwE }) => { - if (estReponse500(reponse)) { - throwE(new ServerError("500 server Error")); - } - return await reponse.json(); - }), - ) - .chain((corpsReponse: unknown) => EitherAsync.liftEither(safeSchemaParse(corpsReponse, WCStoreCartSchema))) - .ifRight((panier: WCStoreCart) => { - E.ENSEMBLE_CODE_PROMO.toggleAttribute(ATTRIBUT_CODE_PROMO_PRESENT); - E.ENSEMBLE_CODE_PROMO.reset(); - E.CHAMP_CODE_PROMO.toggleAttribute(ATTRIBUT_DESACTIVE); - E.CHAMP_CODE_PROMO.textContent = ""; - E.BOUTON_CODE_PROMO.textContent = "Apply"; - - E.TOTAL_PANIER.textContent = pipe( - diviseParCent(panier.totals.total_price), - arrondisADeuxDecimales, - formateEnEuros, - ); - E.TOTAL_REDUCTION_LIGNE.toggleAttribute(ATTRIBUT_HIDDEN); - E.TOTAL_REDUCTION_VALEUR.textContent = "-0€"; - - emetUniqueMessageBroadcastChannel(NOM_CANAL_REVALIDATION_LIVRAISON, true); - }) - .ifLeft((erreur) => - match(erreur) - .with(P.instanceOf(ValiError), (e) => { - reporteErreur(e); - console.error("retour ajout code promo", e.issues); - }) - .with(P.instanceOf(ServerError), (e) => { - reporteErreur(e); - console.error("retour ajout code promo", e); - }) - .with(P.instanceOf(TypeError), (e) => { - reporteErreur(e); - console.error("retour ajout code promo", e); - }) - .exhaustive(), - ) - .finally(() => { - E.BOUTON_CODE_PROMO.removeAttribute(ATTRIBUT_CHARGEMENT); - E.BOUTON_CODE_PROMO.removeAttribute(ATTRIBUT_DESACTIVE); - }) - .run(), + ({ valeurCodePromo }) => undefined, ) - // Ne rien faire en dehors de ces deux situations - .with(P._, identity), - ); + [ + // Ne rien faire en dehors de ces deux situations + "with" + ](P._, identity)); }; diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-evenement.ts b/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-evenement.ts index 23fa7e66..10061edc 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-evenement.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-evenement.ts @@ -26,20 +26,20 @@ export const reinitialiseValidationLivraison = (): void => { * @returns void */ export const souscrisEvenementsPanier = (): void => { - window.addEventListener(ADRESSES_MAJ, (): void => { + globalThis.addEventListener(ADRESSES_MAJ, (): void => { reinitialiseValidationLivraison(); }); - window.addEventListener(CODE_PROMO_MAJ, (): void => { + globalThis.addEventListener(CODE_PROMO_MAJ, (): void => { reinitialiseValidationLivraison(); }); - window.addEventListener(SHIPPING_RATES_UPDATED, (event: Event): void => { + globalThis.addEventListener(SHIPPING_RATES_UPDATED, (event: Event): void => { Either // La vérification du schéma se fait à l'émission .encase(() => (event as UpdatedShippingRatesEvent).detail) // Met à jour le DOM - .ifRight((event) => { + .ifRight(event => { // Met à jour les Méthodes à l'Utilisateur si demandé // Il peut y en avoir aucune if (event.refresh_methods) { @@ -47,18 +47,18 @@ export const souscrisEvenementsPanier = (): void => { } }) // Met à jour le SessionStorage - .chain((event) => eitherSetSessionStorage("shipping_rates", event.shipping_rates)) + .chain(event => eitherSetSessionStorage("shipping_rates", event.shipping_rates)) .ifLeft(reporteEtJournaliseErreur); }); - window.addEventListener(TOTALS_UPDATED, (event: Event): void => { + globalThis.addEventListener(TOTALS_UPDATED, (event: Event): void => { Either // La vérification du Schéma se fait à l'émission .encase(() => (event as UpdatedTotalsEvent).detail.totals) - .chain((ts) => eitherSetSessionStorage("totals", ts)) + .chain(ts => eitherSetSessionStorage("totals", ts)) .ifLeft(reporteEtJournaliseErreur) // Met à jour le DOM - .ifRight((ts) => { + .ifRight(ts => { E.SOUS_TOTAL_LIVRAISON_VALEUR.textContent = formateEnEuros(ts.total_shipping); E.SOUS_TOTAL_PRODUITS_VALEUR.textContent = formateEnEuros(ts.total_items); E.SOUS_TOTAL_REDUCTION_VALEUR.textContent = formateEnEuros(ts.total_discount * -1); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-methodes-livraison.ts b/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-methodes-livraison.ts index 23fe3afe..16d8ee29 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-methodes-livraison.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/page-panier/scripts-page-panier-methodes-livraison.ts @@ -19,7 +19,7 @@ import { getShippingRatesLS } from "./scripts-page-panier-local-storage"; export const initShippingRatesChoicesActions = (): void => { getDOMElementsWithSelector(E.CONTENEUR_METHODES_LIVRAISON)("input").ifRight( - forEach((el: HTMLInputElement): void => + forEach((el: HTMLInputElement): void => { el.addEventListener("click", (event: MouseEvent): void => { // Récupère les méthodes du SessionStorage et les met à jour avec le nouveau choix getShippingRatesLS() @@ -32,10 +32,10 @@ export const initShippingRatesChoicesActions = (): void => { ) // Met à jour les Méthodes de livraison dans le SessionStorage et le DOM .ifJust((srs: WCStoreShippingRateShippingRates): void => { - window.dispatchEvent(createUpdatedShippingRatesEvent(srs, false)); + globalThis.dispatchEvent(createUpdatedShippingRatesEvent(srs, false)); }) // Met à jour les totaux dans le SessionStorage et le DOM - .chain(find((sr) => sr.selected)) + .chain(find(sr => sr.selected)) .ifJust((sr: WCStoreShippingRateShippingRate): void => { getSessionStorageByKey("totals", WCStoreCartTotalsSchema) .ifLeft(reporteEtJournaliseErreur) @@ -45,11 +45,11 @@ export const initShippingRatesChoicesActions = (): void => { return ts; }) .ifRight((ts: WCStoreCartTotals): void => { - window.dispatchEvent(createUpdatedTotalsEvent(ts)); + globalThis.dispatchEvent(createUpdatedTotalsEvent(ts)); }); }); - }), - ), + }); + }), ); }; @@ -64,12 +64,17 @@ export const generateShippingRatesHTML = ( } // Retire les méthodes de livraison initiales - getDOMElementsWithSelector(container)("div[data-methode-initiale]").ifRight(arrayForEach((div) => div.remove())); + getDOMElementsWithSelector(container)("div[data-methode-initiale]").ifRight( + arrayForEach(div => { + div.remove(); + }), + ); - const selectedShippingRate: string = shippingRates.find((sr) => sr.selected)?.method_id ?? ""; + const selectedShippingRate: string = shippingRates.find(sr => sr.selected)?.method_id ?? ""; const shippingRatesHTML: ReadonlyArray = arrayMap( shippingRates, - (methode) => html`
+ methode => + html`
- (cartEntries: ReadonlyArray): void => { + (activated: boolean) => (cartEntries: ReadonlyArray): void => { arrayForEach(cartEntries, (e: CartEntryInteractiveElements): void => { if (activated) { // Active les Boutons @@ -121,10 +120,10 @@ const initActionsOnCartEntries = (): void => { .fromNullable(entryButtons.quantityInput.valueAsNumber) .toEither(new Error("Quantité manquante pour cette ligne du Panier !")), ) - .chain((q) => + .chain(q => EitherAsync.liftEither( safeSchemaParse({ key: entryKey, quantity: q + 1 }, WCStoreCartUpdateItemArgsSchema), - ), + ) ) .ifRight(() => { pipe(cartEntries, arrayMap(getCartEntryInteractiveEles), toggleCartEntryButtons(false)); @@ -136,14 +135,14 @@ const initActionsOnCartEntries = (): void => { nonce: PAGE_STATE.nonce, route: ROUTE_API_MAJ_ARTICLE_PANIER, }), - ), + ) ) .chain((r: Response) => EitherAsync(async ({ throwE }) => match(await newPartialResponse(r)) - ["with"]({ status: 200 }, (r) => r.body) - .otherwise((rs): never => throwE(traiteErreursBackendWooCommerce(rs))), - ), + ["with"]({ status: 200 }, r => r.body) + .otherwise((rs): never => throwE(traiteErreursBackendWooCommerce(rs))) + ) ) .chain((b: unknown) => EitherAsync.liftEither(safeSchemaParse(b, WCStoreCartSchema))) .ifRight((c: WCStoreCart): void => { @@ -161,17 +160,17 @@ const initActionsOnCartEntries = (): void => { }) .ifLeft((err: FetchErrors | HttpCodeErrors | ValiError): void => { match(err) - ["with"](P.instanceOf(ValiError), (e) => { + ["with"](P.instanceOf(ValiError), e => { reporteErreur(e); console.error(e.issues); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_SOUMISSION_ADRESSES; }) - ["with"](P.instanceOf(ServerError), P.instanceOf(BadRequestError), (e) => { + ["with"](P.instanceOf(ServerError), P.instanceOf(BadRequestError), e => { reporteErreur(e); console.error(e); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_SOUMISSION_ADRESSES; }) - ["with"](P.instanceOf(DOMException), P.instanceOf(TypeError), P.instanceOf(Error), (e) => { + ["with"](P.instanceOf(DOMException), P.instanceOf(TypeError), P.instanceOf(Error), e => { reporteErreur(e); console.error(e); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_RESEAU; @@ -191,7 +190,7 @@ const initActionsOnCartEntries = (): void => { Maybe // Nécessaire pour que l'on ait une valeur à incrémenter .fromNullable(entryButtons.quantityInput.valueAsNumber) - .filter((valeur) => valeur > 1) + .filter(valeur => valeur > 1) .ifJust((valeur: number) => { // Réalise la requête et traite sa réponse void EitherAsync @@ -211,7 +210,7 @@ const initActionsOnCartEntries = (): void => { nonce: PAGE_STATE.nonce, route: ROUTE_API_MAJ_ARTICLE_PANIER, }), - ), + ) ) // 4. Traite les cas d'Erreurs et récupère le Corps de la Réponse .chain((reponse: Response) => @@ -220,9 +219,9 @@ const initActionsOnCartEntries = (): void => { match(await newPartialResponse(reponse)) ["with"]({ status: 500 }, () => throwE(new ServerError("500 Server Error"))) ["with"]({ status: 400 }, () => throwE(new BadRequestError("400 Bad Request Error"))) - ["with"]({ status: 200 }, (r) => r.body) - .otherwise((erreur) => throwE(new Error(`Erreur inconnue ${String(erreur.status)}`))), - ), + ["with"]({ status: 200 }, r => r.body) + .otherwise(erreur => throwE(new Error(`Erreur inconnue ${String(erreur.status)}`))) + ) ) // 5. Vérifie le Schéma de la Réponse .chain((corps: unknown) => EitherAsync.liftEither(safeSchemaParse(corps, WCStoreCartSchema))) @@ -243,17 +242,17 @@ const initActionsOnCartEntries = (): void => { // 7. Traite les Erreurs et affiche un message à l'Utilisateur .ifLeft((erreur: BadRequestError | FetchErrors | ServerError | ValiError): void => { match(erreur) - ["with"](P.instanceOf(ValiError), (e) => { + ["with"](P.instanceOf(ValiError), e => { reporteErreur(e); console.error(e.issues); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_SOUMISSION_ADRESSES; }) - ["with"](P.instanceOf(ServerError), P.instanceOf(BadRequestError), (e) => { + ["with"](P.instanceOf(ServerError), P.instanceOf(BadRequestError), e => { reporteErreur(e); console.error(e); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_SOUMISSION_ADRESSES; }) - ["with"](P.instanceOf(DOMException), P.instanceOf(TypeError), P.instanceOf(Error), (e) => { + ["with"](P.instanceOf(DOMException), P.instanceOf(TypeError), P.instanceOf(Error), e => { reporteErreur(e); console.error(e); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_RESEAU; @@ -292,7 +291,7 @@ const initActionsOnCartEntries = (): void => { nonce: PAGE_STATE.nonce, route: ROUTE_API_RETIRE_ARTICLE_PANIER, }), - ), + ) ) // 4. Traite les cas d'Erreurs et récupère le Corps de la Réponse .chain((reponse: Response) => @@ -301,9 +300,9 @@ const initActionsOnCartEntries = (): void => { match(await newPartialResponse(reponse)) ["with"]({ status: 500 }, () => throwE(new ServerError("500 Server Error"))) ["with"]({ status: 400 }, () => throwE(new BadRequestError("400 Bad Request Error"))) - ["with"]({ status: 200 }, (r) => r.body) - .otherwise((erreur) => throwE(new Error(`Erreur inconnue ${String(erreur.status)}`))), - ), + ["with"]({ status: 200 }, r => r.body) + .otherwise(erreur => throwE(new Error(`Erreur inconnue ${String(erreur.status)}`))) + ) ) // 5. Vérifie le Schéma de la Réponse .chain((corps: unknown) => EitherAsync.liftEither(safeSchemaParse(corps, WCStoreCartSchema))) @@ -327,17 +326,17 @@ const initActionsOnCartEntries = (): void => { // 7. Traite les Erreurs et affiche un message à l'Utilisateur .ifLeft((erreur: BadRequestError | FetchErrors | ServerError | ValiError): void => { match(erreur) - ["with"](P.instanceOf(ValiError), (e) => { + ["with"](P.instanceOf(ValiError), e => { reporteErreur(e); console.error(e.issues); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_SOUMISSION_ADRESSES; }) - ["with"](P.instanceOf(ServerError), P.instanceOf(BadRequestError), (e) => { + ["with"](P.instanceOf(ServerError), P.instanceOf(BadRequestError), e => { reporteErreur(e); console.error(e); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_SOUMISSION_ADRESSES; }) - ["with"](P.instanceOf(DOMException), P.instanceOf(TypeError), P.instanceOf(Error), (e) => { + ["with"](P.instanceOf(DOMException), P.instanceOf(TypeError), P.instanceOf(Error), e => { reporteErreur(e); console.error(e); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_RESEAU; @@ -352,10 +351,10 @@ const initActionsOnCartEntries = (): void => { }); }, ) - .otherwise((_) => {}); + .otherwise(_ => {}); }); }); }); }; -export { toggleCartEntryButtons, initActionsOnCartEntries as initialiseActionsEntreesPanier }; +export { initActionsOnCartEntries as initialiseActionsEntreesPanier, toggleCartEntryButtons }; diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-bouton-retour-sommet.ts b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-bouton-retour-sommet.ts index 8d209918..5e24eeac 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-bouton-retour-sommet.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-bouton-retour-sommet.ts @@ -68,9 +68,9 @@ const initialiseObservationFenetre = (): void => { } etapePlanifiee = true; - requestAnimationFrame((): void => - majVisibiliteBouton(defilementY > window.innerHeight * RATIO_MINIMUM_PAGE_PAR_FENETRE), - ); + requestAnimationFrame((): void => { + majVisibiliteBouton(defilementY > window.innerHeight * RATIO_MINIMUM_PAGE_PAR_FENETRE); + }); }); new ResizeObserver((entrees: Array): void => { diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-menu-categories.ts b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-menu-categories.ts index eb30992e..c6bb61e3 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-menu-categories.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-menu-categories.ts @@ -2,13 +2,14 @@ import { Array as EffectArray, Match, Predicate } from "effect"; -import { DOM_ENTREES_MENU_CATEGORIES_PRODUITS, DOM_MENU_CATEGORIES_PRODUITS } from "./constantes/dom.ts"; import { getAllSelectorFromDocumentOrThrow, getFirstSelectorFromDocumentOrThrow } from "../scripts-effect/lib/dom.ts"; +import { DOM_ENTREES_MENU_CATEGORIES_PRODUITS, DOM_MENU_CATEGORIES_PRODUITS } from "./constantes/dom.ts"; // Initialise les attributs HTML pour l'affichage initiale des flèches de défilement du menu de catégories de Produits. document.addEventListener("DOMContentLoaded", (): void => { - const productsCategoriesMenu: HTMLElement = - getFirstSelectorFromDocumentOrThrow(DOM_MENU_CATEGORIES_PRODUITS); + const productsCategoriesMenu: HTMLElement = getFirstSelectorFromDocumentOrThrow( + DOM_MENU_CATEGORIES_PRODUITS, + ); const menuEntries: ReadonlyArray = getAllSelectorFromDocumentOrThrow( DOM_ENTREES_MENU_CATEGORIES_PRODUITS, ); @@ -22,17 +23,25 @@ document.addEventListener("DOMContentLoaded", (): void => { } new IntersectionObserver( - EffectArray.forEach((intersectionEntry) => { + EffectArray.forEach(intersectionEntry => { // Ne déclenche rien si le scroll n'est pas horizontal if (intersectionEntry.boundingClientRect.top <= 0) { return; } Match.value([intersectionEntry.isIntersecting]).pipe( - Match.when([true, 0], () => productsCategoriesMenu.removeAttribute("data-entrees-presentes-debut")), - Match.when([true, 1], () => productsCategoriesMenu.removeAttribute("data-entrees-presentes-fin")), - Match.when([false, 0], () => productsCategoriesMenu.setAttribute("data-entrees-presentes-debut", "")), - Match.when([false, 1], () => productsCategoriesMenu.setAttribute("data-entrees-presentes-fin", "")), + Match.when([true, 0], () => { + productsCategoriesMenu.removeAttribute("data-entrees-presentes-debut"); + }), + Match.when([true, 1], () => { + productsCategoriesMenu.removeAttribute("data-entrees-presentes-fin"); + }), + Match.when([false, 0], () => { + productsCategoriesMenu.setAttribute("data-entrees-presentes-debut", ""); + }), + Match.when([false, 1], () => { + productsCategoriesMenu.setAttribute("data-entrees-presentes-fin", ""); + }), Match.orElse(() => {}), ); }), diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-menu-mobile.ts b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-menu-mobile.ts index 0e2ffd26..a945589b 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-menu-mobile.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-menu-mobile.ts @@ -18,19 +18,19 @@ const E = { const initialiseBoutonMenuMobile = (): void => { const menuMobile = new A11yDialog(E.MENU_MOBILE); - new ResizeObserver((entrees) => + new ResizeObserver(entrees => // Cache le Menu mobile pour les grandes tailles d'écrans pipe( A.head(entrees), O.filter((entree: ResizeObserverEntry) => entree.borderBoxSize[0]!.inlineSize > 1000), - O.tap((_) => menuMobile.hide()), - ), + O.tap(_ => menuMobile.hide()), + ) ).observe(E.CORPS_HTML); E.BOUTON_MENU_MOBILE.addEventListener("click", (): void => { // Renvoie à la Page d'accueil pour les grandes tailles d'écrans if (window.innerWidth > 1000) { - window.location.href = "/"; + globalThis.location.href = "/"; return; } // Cache le Menu mobile s'il est actif diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-a-propos.ts b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-a-propos.ts index a16654ad..248a4584 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-a-propos.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-a-propos.ts @@ -2,7 +2,7 @@ * Scripts pour les fonctionnalités de la Page À Propos (« About »). */ -import { A, pipe as beltPipe, O } from "@mobily/ts-belt"; +import { A, O, pipe as beltPipe } from "@mobily/ts-belt"; import { ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF, @@ -48,7 +48,11 @@ document.addEventListener("DOMContentLoaded", (): void => { O.tap((id: string) => { beltPipe( O.fromNullable(ENSEMBLES_EPINGLES_BOITES_TEXTE.get(id)), - O.tap(A.forEach((element) => element.removeAttribute(ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF))), + O.tap( + A.forEach(element => { + element.removeAttribute(ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF); + }), + ), ); }), ); @@ -64,7 +68,11 @@ document.addEventListener("DOMContentLoaded", (): void => { if (cible.hasAttribute(ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF)) { beltPipe( O.fromNullable(ENSEMBLES_EPINGLES_BOITES_TEXTE.get(id)), - O.tap(A.forEach((element) => element.removeAttribute(ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF))), + O.tap( + A.forEach(element => { + element.removeAttribute(ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF); + }), + ), ); return; } @@ -73,12 +81,14 @@ document.addEventListener("DOMContentLoaded", (): void => { beltPipe( Array.from(ENSEMBLES_EPINGLES_BOITES_TEXTE.values()), A.flat, - A.forEach((element) => element.removeAttribute(ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF)), + A.forEach(element => { + element.removeAttribute(ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF); + }), ); // Active l'Attribut sur l'Ensemble beltPipe( O.fromNullable(ENSEMBLES_EPINGLES_BOITES_TEXTE.get(id)), - O.tap(A.forEach((element) => element.toggleAttribute(ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF))), + O.tap(A.forEach(element => element.toggleAttribute(ATTRIBUT_ENSEMBLE_EPINGLE_BOITE_ACTIF))), ); }), ); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-accueil.ts b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-accueil.ts index e073a4fe..2ba3d398 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-accueil.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-accueil.ts @@ -94,23 +94,25 @@ const initDefilementStorytelling = (): void => { }).observe(E.STORYTELLING); // Initialise la mise à jour des images au défilement sur le Conteneur. - E.STORYTELLING.addEventListener("scroll", (): void => majVisibilitéImagesStorytelling()); + E.STORYTELLING.addEventListener("scroll", (): void => { + majVisibilitéImagesStorytelling(); + }); }; const initGestionAnimation = (): void => { pipe( A.at(E.IMAGES_STORYTELLING, 0), - O.tap((img) => { + O.tap(img => { const options: IntersectionObserverInit = { root: undefined, rootMargin: "0px", threshold: 0, }; const callback = (entries: Array) => { - A.forEach(entries, (e) => { - e.intersectionRatio >= 0.9 - ? E.CONTENEUR_ANIMATION.removeAttribute(ATTRIBUT_HIDDEN) - : E.CONTENEUR_ANIMATION.setAttribute(ATTRIBUT_HIDDEN, ""); + A.forEach(entries, e => { + e.intersectionRatio >= 0.9 ? + E.CONTENEUR_ANIMATION.removeAttribute(ATTRIBUT_HIDDEN) : + E.CONTENEUR_ANIMATION.setAttribute(ATTRIBUT_HIDDEN, ""); }); }; diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-boutique.ts b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-boutique.ts index b215ace9..5f8b9d50 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-boutique.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-boutique.ts @@ -13,6 +13,7 @@ import type { WCV3Products, WCV3ProductsArgs } from "./lib/types/api/v3/products import type { GenericPageState } from "./lib/types/pages"; import { ROUTE_API_NOUVELLE_PRODUCTS } from "./constantes/api.ts"; +import { PRODUCT_STATUTES } from "./constantes/api/products.ts"; import { ATTRIBUT_CHARGEMENT, ATTRIBUT_DESACTIVE, @@ -28,7 +29,6 @@ import { BadRequestError, reporteErreur, ServerError } from "./lib/erreurs.ts"; import { getBackendAvecParametresUrl, newPartialResponse } from "./lib/reseau.ts"; import { WCV3ProductsArgsSchema, WCV3ProductsSchema } from "./lib/schemas/api/v3/products.ts"; import { safeSchemaParse } from "./lib/validation.ts"; -import { PRODUCT_STATUTES } from "./constantes/api/products.ts"; type APIProductsErrors = | APIFetchErrors @@ -67,109 +67,7 @@ const initialisePageBoutique = (): void => { ...(idCategorieProduits && { category: idCategorieProduits }), }; - void EitherAsync - // 1. Valide les Arguments de la Requête - .liftEither(safeSchemaParse(args, WCV3ProductsArgsSchema)) - // 2. Exécute un Effet pour empêcher les requêtes concurrentes et lancer une animation de chargement - .ifRight((): void => { - // Désactive le Bouton pour empêcher des requêtes concurrentes - E.BOUTON_PLUS_DE_PRODUITS.setAttribute(ATTRIBUT_DESACTIVE, ""); - E.BOUTON_PLUS_DE_PRODUITS.setAttribute(ATTRIBUT_CHARGEMENT, ""); - - // Lance un cycle d'animation sur le texte de chargement - lanceAnimationCycleLoading(E.BOUTON_PLUS_DE_PRODUITS, 500); - }) - // 3. Exécute la requête via fetch sous forme d'EitherAsync - .chain((args: WCV3ProductsArgs) => - EitherAsync(() => - getBackendAvecParametresUrl({ - authString: ETATS_PAGE.authString, - nonce: ETATS_PAGE.nonce, - route: ROUTE_API_NOUVELLE_PRODUCTS, - searchParams: new URLSearchParams(args).toString(), - }), - ), - ) - // 4. Traite les cas d'Erreurs et récupère le Corps de la Réponse - .chain((reponse: Response) => - EitherAsync(async ({ throwE }) => - match(await newPartialResponse(reponse)) - .with({ status: 500 }, () => throwE(new ServerError("500 Server Error"))) - .with({ status: 400 }, () => throwE(new BadRequestError("400 Server Error"))) - .with({ status: 200 }, (r) => r.body) - .run(), - ), - ) - // 5. Vérifie le Schéma de la Réponse - .chain((corpsReponse: unknown) => EitherAsync.liftEither(safeSchemaParse(corpsReponse, WCV3ProductsSchema))) - // 6. Exécute un Effet pour la mise à jour du DOM avec les Résultats - .ifRight((donnees: WCV3Products) => { - // Cache le bouton s'il y a moins de PRODUCTS_PER_PAGE Produits disponibles (que l'on est à la dernière page) - if (donnees.length < PRODUCTS_PER_PAGE) { - E.BOUTON_PLUS_DE_PRODUITS.toggleAttribute(ATTRIBUT_HIDDEN); - } - - // Créé un DocumentFragment qui recevra tous les nouveaux Produits - const fragment: DocumentFragment = document.createDocumentFragment(); - - // Créé les Éléments
à insérer - for (const produit of donnees.slice(0, PRODUCTS_PER_PAGE)) { - pipe( - html` - - `, - tap((article) => fragment.append(article)), - ); - } - - // Ajoute les nouveaux Produits dans le DOM - E.GRILLE_PRODUITS.append(fragment); - E.GRILLE_PRODUITS.setAttribute(ATTRIBUT_PAGE, String(nouveauNumeroPage)); - - E.BOUTON_PLUS_DE_PRODUITS.textContent = "Show more"; - }) - // 7. Traite les Erreurs et affiche un Message à l'Utilisateur - .ifLeft((erreur: APIProductsErrors) => { - match(erreur) - .with(P.instanceOf(ValiError), (e) => { - reporteErreur(e); - console.error("ValiError", e.issues); - }) - .otherwise((e) => { - reporteErreur(e); - console.error("Erreur", e); - }); - - E.BOUTON_PLUS_DE_PRODUITS.textContent = "Error, try again?"; - }) - // 8. Quel que soit le résultat, réactiver le Bouton et arrêter l'animation - .finally(() => { - // Désactive l'animation de chargement et rend le Bouton de nouveau cliquable - E.BOUTON_PLUS_DE_PRODUITS.removeAttribute(ATTRIBUT_CHARGEMENT); - E.BOUTON_PLUS_DE_PRODUITS.removeAttribute(ATTRIBUT_DESACTIVE); - }) - .run(); + undefined; }); }; diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-panier.ts b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-panier.ts index 07460649..d5256518 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-panier.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-panier.ts @@ -8,6 +8,8 @@ import type { MessageMajContenuPanierSchema } from "./lib/schemas/messages.ts"; import type { WCStoreCartItem } from "./lib/types/api/cart"; import type { MessageMajBoutonPanierDonnees, MessageMajContenuPanierDonnees } from "./lib/types/messages"; +import { Effect } from "effect"; +import { Effect } from "effect"; import { ATTRIBUT_CLE_PANIER, ATTRIBUT_CONTIENT_ARTICLES, @@ -36,7 +38,6 @@ import { E } from "./page-panier/scripts-page-panier-elements.ts"; import { souscrisEvenementsPanier } from "./page-panier/scripts-page-panier-evenement.ts"; import { initShippingRatesChoicesActions } from "./page-panier/scripts-page-panier-methodes-livraison.ts"; import { initialiseActionsEntreesPanier } from "./page-panier/scripts-page-panier-panneau-produits.ts"; -import { Effect } from "effect"; type ElementsEntreePanier = { boutonAddition: HTMLButtonElement; @@ -54,7 +55,6 @@ type EtatsPage = { // @ts-expect-error -- États injectés par le modèle PHP // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- États injectés par le modèle PHP -const ETATS_PAGE: EtatsPage = _etats; /** * Fonction utilitaire pour récupérer un Élément dans une ligne (entrée) du Panier, en levant une @@ -64,13 +64,11 @@ const ETATS_PAGE: EtatsPage = _etats; * @returns L'Élément demandé. * @throws Une SyntaxError si l'Élément n'est pas trouvé. */ -const recupereElementDansEntreePanierOuLeve = - (entree: HTMLElement) => - (selecteur: string) => - pipe(recupereElementAvecSelecteur(entree)(selecteur), recupereElementOuLeve); +const recupereElementDansEntreePanierOuLeve = (entree: HTMLElement) => (selecteur: string) => + pipe(recupereElementAvecSelecteur(entree)(selecteur), recupereElementOuLeve); // NOTE: Nécessaire pour éviter une condition de course entre la réussite de la requête et l'émission effective du Message -const majEtatsActivationBoutons = (entrees: Array): void => +const majEtatsActivationBoutons = (entrees: Array): void => { entrees.forEach((entree: HTMLElement) => { // Fonction utilitaire const recupereElementDansEntree = recupereElementDansEntreePanierOuLeve(entree); @@ -82,13 +80,14 @@ const majEtatsActivationBoutons = (entrees: Array): void => champQuantite: recupereElementDansEntree(DOM_CHAMP_QUANTITE_LIGNE_PANIER), }; - Number(elements.champQuantite?.value) === 1 - ? elements.boutonSoustraction.setAttribute(ATTRIBUT_DESACTIVE, "") - : elements.boutonSoustraction.removeAttribute(ATTRIBUT_DESACTIVE); + Number(elements.champQuantite?.value) === 1 ? + elements.boutonSoustraction.setAttribute(ATTRIBUT_DESACTIVE, "") : + elements.boutonSoustraction.removeAttribute(ATTRIBUT_DESACTIVE); elements.boutonAddition.removeAttribute(ATTRIBUT_DESACTIVE); elements.boutonSuppression.removeAttribute(ATTRIBUT_DESACTIVE); elements.boutonSuppression.textContent = "Remove"; }); +}; const initialiseMajConteneurPanier = (): void => { new BroadcastChannel(NOM_CANAL_BOUTON_PANIER).onmessage = (evenementMessage: MessageEvent): void => { @@ -111,7 +110,7 @@ const initialiseMajContenuPanier = (): void => { donnees.produits.forEach((ligne: WCStoreCartItem) => { // Met à jour les entrées du Panier E.ENTREES_PANIER.ifRight((entrees: Array) => { - Maybe.fromNullable(entrees.find((entree) => entree.getAttribute(ATTRIBUT_CLE_PANIER) === ligne.key)).ifJust( + Maybe.fromNullable(entrees.find(entree => entree.getAttribute(ATTRIBUT_CLE_PANIER) === ligne.key)).ifJust( (entree: HTMLElement) => { // Fonction utilitaire const recupereElementDansEntree = recupereElementDansEntreePanierOuLeve(entree); @@ -144,7 +143,9 @@ const initialiseMajContenuPanier = (): void => { // Reporte tout Erreur et réactive les Boutons .ifLeft((erreur: CleNonTrouveError | ValiError) => { reporteErreur(erreur); - E.ENTREES_PANIER.ifRight((entrees) => majEtatsActivationBoutons(entrees)); + E.ENTREES_PANIER.ifRight(entrees => { + majEtatsActivationBoutons(entrees); + }); }); }; }; @@ -157,7 +158,9 @@ const initialiseMajFormulairesPanier = (): void => { // Rend visible le formulaire de facturation. E.FORMULAIRE_FACTURATION.removeAttribute(ATTRIBUT_HIDDEN); getDOMElementsWithSelector(E.FORMULAIRE_FACTURATION)("input, select").ifRight( - arrayForEach((champ) => champ.removeAttribute(ATTRIBUT_DESACTIVE)), + arrayForEach(champ => { + champ.removeAttribute(ATTRIBUT_DESACTIVE); + }), ); }) // Les Adresses sont combinées. @@ -167,7 +170,7 @@ const initialiseMajFormulairesPanier = (): void => { getDOMElementsWithSelector(E.FORMULAIRE_FACTURATION)( "input, select", ).ifRight( - arrayForEach((champ) => { + arrayForEach(champ => { champ.setAttribute(ATTRIBUT_DESACTIVE, ""); champ.value = ""; }), diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-produit-service.ts b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-produit-service.ts new file mode 100644 index 00000000..20797b15 --- /dev/null +++ b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-produit-service.ts @@ -0,0 +1,132 @@ +import { Array as FxArray, Console, Effect, HashMap, Layer, ManagedRuntime, Option, pipe, ServiceMap } from "effect"; +import { NonEmptyReadonlyArray } from "effect/Array"; +import { NoSuchElementError } from "effect/Cause"; +import { getAllSelectorFromDocument, getFirstSelectorFromDocument } from "../scripts-effect/lib/dom.ts"; +import { + ATTRIBUT_ARIA_CONTROLS, + ATTRIBUT_ARIA_EXPANDED, + ATTRIBUT_HIDDEN, + DOM_BOUTON_AJOUT_PANIER, + DOM_BOUTONS_ACCORDEON, + DOM_CONTENUS_ACCORDEON, + DOM_PRIX_PRODUIT, +} from "./constantes/dom.ts"; +import { WCStoreCartAddItemArgsItems } from "./lib/types/api/cart-add-item"; + +/** Représente un ensemble bouton-contenu d'une Section dans la description du Produit. */ +type DetailEnsemble = { + button: HTMLButtonElement; + content: HTMLDivElement; +}; + +class ProductPageElements extends ServiceMap.Service< + ProductPageElements, + { + AddProductButton: HTMLButtonElement; + DetailsButtons: NonEmptyReadonlyArray; + DetailsContents: NonEmptyReadonlyArray; + Details: HashMap.HashMap; + ProductPrice: HTMLParagraphElement; + ProductRawJson: HTMLScriptElement; + VariationChoiceForm: HTMLFormElement; + VariationSelectors: ReadonlyArray; + } +>()("haikuatelier.fr/Produit/ProductPageElements") { + static readonly layer = Layer.effect( + ProductPageElements, + Effect.gen(function*() { + const AddProductButton = yield* getFirstSelectorFromDocument(DOM_BOUTON_AJOUT_PANIER); + const DetailsButtons = yield* getAllSelectorFromDocument(DOM_BOUTONS_ACCORDEON); + const DetailsContents = yield* getAllSelectorFromDocument(DOM_CONTENUS_ACCORDEON); + const ProductPrice = yield* getFirstSelectorFromDocument(DOM_PRIX_PRODUIT); + const ProductRawJson = yield* getFirstSelectorFromDocument("#product-json"); + const VariationChoiceForm = yield* getFirstSelectorFromDocument("#variation-choice"); + const VariationSelectors = yield* pipe( + getAllSelectorFromDocument(".selecteur-produit select"), + Option.orElseSome(() => FxArray.empty()), + ); + + const Details = yield* pipe( + DetailsButtons, + FxArray.map( + (button: HTMLButtonElement, index: number): Effect.Effect<[string, DetailEnsemble], NoSuchElementError> => + Effect.gen(function*() { + const contentId = yield* Option.fromNullishOr(button.getAttribute(ATTRIBUT_ARIA_CONTROLS)); + const content = yield* FxArray.get(DetailsContents, index); + + return [contentId, { button, content } satisfies DetailEnsemble]; + }), + ), + Effect.all, + Effect.map(HashMap.fromIterable), + ); + + return ProductPageElements.of({ + AddProductButton, + DetailsButtons, + DetailsContents, + Details, + ProductPrice, + ProductRawJson, + VariationChoiceForm, + VariationSelectors, + }); + }), + ); +} + +class ProductPageDOM extends ServiceMap.Service< + ProductPageDOM, + { + /** + * Replie toutes les sections de la description du Produit. + */ + toggleAllDetails: () => Effect.Effect; + /** + * Récupère les Attributs du Produit depuis les Elements au sein du DOM. + */ + getProductAttributesFromDOM: () => Effect.Effect>; + } +>()("haikuatelier.fr/Produit/ProductPageDOM") { + static readonly layer = Layer.effect( + ProductPageDOM, + Effect.gen(function*() { + const { Details, VariationSelectors } = yield* ProductPageElements; + + const toggleAllDetails: () => Effect.Effect = () => + Effect.sync((): void => { + pipe( + // Récupère les Sections sous forme d'Ensembles. + [...HashMap.values(Details)], + FxArray.forEach((detail: DetailEnsemble) => { + detail.button.toggleAttribute(ATTRIBUT_ARIA_EXPANDED, false); + detail.content.toggleAttribute(ATTRIBUT_HIDDEN, true); + }), + ); + }); + + const getProductAttributesFromDOM: () => Effect.Effect> = () => + Effect.sync(() => + FxArray.map(VariationSelectors, (select: HTMLSelectElement) => ({ + attribute: select.id, + value: select.value, + })) + ); + + return ProductPageDOM.of({ + getProductAttributesFromDOM, + toggleAllDetails, + }); + }), + ); +} + +const ProductPageRuntime = ManagedRuntime.make( + pipe( + ProductPageDOM.layer, + Layer.provide(ProductPageElements.layer), + Layer.tapError(error => Console.error("ManagedRuntime", "Impossible de créer le Layer :", error.name)), + ), +); + +export { type DetailEnsemble, ProductPageDOM, ProductPageElements, ProductPageRuntime }; diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-produit.ts b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-produit.ts index 858960cd..c81ac96b 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-produit.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/scripts-page-produit.ts @@ -3,25 +3,14 @@ import { pipe } from "@mobily/ts-belt"; import { get as dictGet } from "@mobily/ts-belt/Dict"; import { tap as optionTap } from "@mobily/ts-belt/Option"; -import { - Array as FxArray, - Effect, - pipe as epipe, - Option, - Stream, - ServiceMap, - Layer, - ManagedRuntime, - Console, - HashMap, -} from "effect"; +import { Array as FxArray, Console, Effect, HashMap, Option, pipe as epipe, Stream } from "effect"; import { EitherAsync } from "purify-ts"; import { match, P } from "ts-pattern"; import { ValiError } from "valibot"; import type { AnySchema } from "valibot"; -import type { WCStoreCart } from "./lib/types/api/cart.ts"; import type { WCStoreCartAddItemArgs, WCStoreCartAddItemArgsItems } from "./lib/types/api/cart-add-item.ts"; +import type { WCStoreCart } from "./lib/types/api/cart.ts"; import type { FetchErrors } from "./lib/types/reseau.ts"; import { ROUTE_API_AJOUTE_ARTICLE_PANIER } from "./constantes/api.ts"; @@ -45,14 +34,7 @@ import { newPartialResponse, postBackend, safeFetch } from "./lib/reseau.ts"; import { WCStoreCartAddItemArgsSchema } from "./lib/schemas/api/cart-add-item.ts"; import { WCStoreCartSchema } from "./lib/schemas/api/cart.ts"; import { safeSchemaParse } from "./lib/validation"; -import { getAllSelectorFromDocument, getFirstSelectorFromDocument } from "../scripts-effect/lib/dom.ts"; -import { NonEmptyReadonlyArray } from "effect/Array"; -import { NoSuchElementError } from "effect/Cause"; - -type DetailEnsemble = { - button: HTMLButtonElement; - content: HTMLDivElement; -}; +import { ProductPageElements, ProductPageRuntime } from "./scripts-page-produit-service.ts"; /** États utiles pour les scripts de la page. */ type EtatsPage = { @@ -65,69 +47,6 @@ type EtatsPage = { // @ts-expect-error -- États injectés par le modèle PHP const ETATS_PAGE: EtatsPage = _etats; -class ProductPageElements extends ServiceMap.Service< - ProductPageElements, - { - AddProductButton: HTMLButtonElement; - DetailsButtons: NonEmptyReadonlyArray; - DetailsContents: NonEmptyReadonlyArray; - Details: HashMap.HashMap; - ProductPrice: HTMLParagraphElement; - ProductRawJson: HTMLScriptElement; - VariationChoiceForm: HTMLFormElement; - VariationSelectors: ReadonlyArray; - } ->()("haikuatelier.fr/Produit/ProductPageElements") { - static readonly layer = Layer.effect( - ProductPageElements, - Effect.gen(function* () { - const AddProductButton = yield* getFirstSelectorFromDocument(DOM_BOUTON_AJOUT_PANIER); - const DetailsButtons = yield* getAllSelectorFromDocument(DOM_BOUTONS_ACCORDEON); - const DetailsContents = yield* getAllSelectorFromDocument(DOM_CONTENUS_ACCORDEON); - const ProductPrice = yield* getFirstSelectorFromDocument(DOM_PRIX_PRODUIT); - const ProductRawJson = yield* getFirstSelectorFromDocument("#product-json"); - const VariationChoiceForm = yield* getFirstSelectorFromDocument("#variation-choice"); - const VariationSelectors = yield* pipe( - getAllSelectorFromDocument(".selecteur-produit select"), - Option.orElseSome(() => FxArray.empty()), - ); - - const Details = yield* pipe( - DetailsButtons, - FxArray.map( - (button: HTMLButtonElement, index: number): Effect.Effect<[string, DetailEnsemble], NoSuchElementError> => - Effect.gen(function* () { - const contentId = yield* Option.fromNullishOr(button.getAttribute(ATTRIBUT_ARIA_CONTROLS)); - const content = yield* FxArray.get(DetailsContents, index); - - return [contentId, { button, content } satisfies DetailEnsemble]; - }), - ), - Effect.all, - Effect.map(HashMap.fromIterable), - ); - - return { - AddProductButton, - DetailsButtons, - DetailsContents, - Details, - ProductPrice, - ProductRawJson, - VariationChoiceForm, - VariationSelectors, - }; - }), - ); -} - -const ProductPageRuntime = ManagedRuntime.make( - pipe( - ProductPageElements.layer, - Layer.tapError((error) => Console.error("ManagedRuntime", "Impossible de créer le Layer :", error.name)), - ), -); - // Éléments d'intérêt const E = { BOUTON_AJOUT_PANIER: mustGetEleInDocument(DOM_BOUTON_AJOUT_PANIER), @@ -139,35 +58,6 @@ const E = { VARIATION_CHOICE_FORM: mustGetEleInDocument("#variation-choice"), }; -const toggleAllDetails = Effect.fn("toggleAllDetails")(function* () { - const PageElements = yield* ProductPageElements; - // Récupère les Ensembles sous forme de tableau. - const details = [...HashMap.values(PageElements.Details)]; - - FxArray.forEach(details, (detail: DetailEnsemble) => { - detail.button.toggleAttribute(ATTRIBUT_ARIA_EXPANDED, false); - detail.content.toggleAttribute(ATTRIBUT_HIDDEN, true); - }); -}); - -// TODO: Utiliser Effect. -const getAttributesFromDom = (): ReadonlyArray => { - const selectElements = epipe( - document.querySelectorAll(".selecteur-produit select"), - Array.from, - ); - if (selectElements.length === 0) { - return []; - } - - const attributes = selectElements.map((select: HTMLSelectElement) => ({ - attribute: select.id, - value: select.value, - })); - - return attributes; -}; - const areArraysEqual = (array1: Array, array2: Array): boolean => { if (array1 !== array2) { const a1 = JSON.stringify(array1.toSorted()); @@ -186,7 +76,7 @@ const updatePriceOnAttributeChange = (): void => { const productVariations: Array = epipe(E.PRODUCT_JSON.textContent, JSON.parse)?.variations; const chosenAttributes = getAttributesFromDom(); - const chosenVariation = productVariations.find((v) => areArraysEqual(v.attributes, chosenAttributes)); + const chosenVariation = productVariations.find(v => areArraysEqual(v.attributes, chosenAttributes)); const newPrice: string = chosenVariation.price; E.PRIX_PRODUIT.textContent = `${newPrice}€`; @@ -227,7 +117,7 @@ const ajouteProduitAuPanier = (event: MouseEvent): void => { nonce: ETATS_PAGE.nonce, route: ROUTE_API_AJOUTE_ARTICLE_PANIER, }), - ), + ) ) // 4. Traite les cas d'Erreurs et récupère le Corps de la Réponse .chain((reponse: Response) => @@ -236,9 +126,9 @@ const ajouteProduitAuPanier = (event: MouseEvent): void => { match(await newPartialResponse(reponse)) .with({ status: 500 }, () => throwE(new ServerError("500 Server Error"))) .with({ status: 400 }, () => throwE(new BadRequestError("400 Bad Request Error"))) - .with({ status: 201 }, (r) => r.body) - .otherwise((erreur) => throwE(new Error(`Erreur inconnue ${String(erreur.status)}`))), - ), + .with({ status: 201 }, r => r.body) + .otherwise(erreur => throwE(new Error(`Erreur inconnue ${String(erreur.status)}`))) + ) ) // 5. Vérifie le Schéma de la Réponse .chain((corpsReponse: unknown) => EitherAsync.liftEither(safeSchemaParse(corpsReponse, WCStoreCartSchema))) @@ -250,21 +140,21 @@ const ajouteProduitAuPanier = (event: MouseEvent): void => { E.BOUTON_AJOUT_PANIER.textContent = "Added to cart!"; emetMessageMajBoutonPanier({ quantiteProduits: totalArticles }); }), - ), + ) ) .ifLeft((erreur: BadRequestError | FetchErrors | ServerError | ValiError) => { match(erreur) - .with(P.instanceOf(ValiError), (e) => { + .with(P.instanceOf(ValiError), e => { reporteErreur(e); console.error(e.issues); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_SOUMISSION_ADRESSES; }) - .with(P.instanceOf(ServerError), P.instanceOf(BadRequestError), (e) => { + .with(P.instanceOf(ServerError), P.instanceOf(BadRequestError), e => { reporteErreur(e); console.error(e); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_SOUMISSION_ADRESSES; }) - .with(P.instanceOf(DOMException), P.instanceOf(TypeError), P.instanceOf(Error), (e) => { + .with(P.instanceOf(DOMException), P.instanceOf(TypeError), P.instanceOf(Error), e => { reporteErreur(e); console.error(e); // E.MESSAGE_ADRESSES.textContent = ERREUR_GENERIQUE_RESEAU; @@ -284,7 +174,7 @@ const ajouteProduitAuPanier = (event: MouseEvent): void => { /** * Initialise l'état initial d'interactivité du Bouton d'ajout de Produit au Panier. */ -const initAddToCartButton = Effect.fn("initAddToCartButton")(function* () { +const initAddToCartButton = Effect.fn("initAddToCartButton")(function*() { const { AddProductButton, VariationSelectors } = yield* ProductPageElements; /** Est-ce que le Produit affiché est en stock ? */ const isProductInStock = AddProductButton.hasAttribute("data-in-stock") === true; @@ -304,7 +194,7 @@ const initAddToCartButton = Effect.fn("initAddToCartButton")(function* () { return yield* Effect.void; }); -const onFormChange = Effect.fnUntraced(function* (event: Event) { +const onFormChange = Effect.fnUntraced(function*(event: Event) { const { AddProductButton } = yield* ProductPageElements; // La cible ne peut qu'être un Formulaire. const target = event.target as HTMLFormElement; @@ -319,7 +209,7 @@ const onFormChange = Effect.fnUntraced(function* (event: Event) { /** * Initialise la mise à jour de l'état d'interactivité du Bouton d'ajout de Produit au Panier en fonction des actions de l'Utilisateur. */ -const initAddToCartInteractionUpdates = Effect.fn("initAddToCartInteractionUpdates")(function* () { +const initAddToCartInteractionUpdates = Effect.fn("initAddToCartInteractionUpdates")(function*() { return yield* pipe( Stream.fromEventListener(E.VARIATION_CHOICE_FORM, "change"), Stream.tap(onFormChange), @@ -327,7 +217,7 @@ const initAddToCartInteractionUpdates = Effect.fn("initAddToCartInteractionUpdat ); }); -const onDetailButtonClick = Effect.fnUntraced(function* (event: Event) { +const onDetailButtonClick = Effect.fnUntraced(function*(event: Event) { const { Details } = yield* ProductPageElements; // Empêche la pollution de l'historique de navigation event.preventDefault(); @@ -357,18 +247,36 @@ const onDetailButtonClick = Effect.fnUntraced(function* (event: Event) { return yield* Effect.void; }); -const initDetailInteractions = Effect.fn("initDetailInteractions")(function* () { +const initDetailInteractions = Effect.fn("initDetailInteractions")(function*() { const PageElements = yield* ProductPageElements; return yield* pipe( - FxArray.map(PageElements.DetailsButtons, (button: HTMLButtonElement) => - pipe(Stream.fromEventListener(button, "click"), Stream.tap(onDetailButtonClick)), + FxArray.map( + PageElements.DetailsButtons, + (button: HTMLButtonElement) => pipe(Stream.fromEventListener(button, "click"), Stream.tap(onDetailButtonClick)), ), Stream.mergeAll({ concurrency: "unbounded" }), Stream.runDrain, ); }); +const getAttributesFromDom = (): ReadonlyArray => { + const selectElements = epipe( + document.querySelectorAll(".selecteur-produit select"), + Array.from, + ); + if (selectElements.length === 0) { + return []; + } + + const attributes = selectElements.map((select: HTMLSelectElement) => ({ + attribute: select.id, + value: select.value, + })); + + return attributes; +}; + document.addEventListener("DOMContentLoaded", (): void => { ProductPageRuntime.runFork(pipe(initAddToCartButton(), Effect.tapCause(Console.error))); ProductPageRuntime.runFork(pipe(initAddToCartInteractionUpdates(), Effect.tapCause(Console.error))); diff --git a/web/app/themes/haiku-atelier-2024/src/scripts/vite.env.d.ts b/web/app/themes/haiku-atelier-2024/src/scripts/vite.env.d.ts index e1aa1375..d4f53029 100755 --- a/web/app/themes/haiku-atelier-2024/src/scripts/vite.env.d.ts +++ b/web/app/themes/haiku-atelier-2024/src/scripts/vite.env.d.ts @@ -1,7 +1,7 @@ /// -type ImportMeta = { - readonly env: ImportMetaEnv; -}; +type ImportMeta = Readonly<{ + env: ImportMetaEnv; +}>; type ImportMetaEnv = {}; diff --git a/web/app/themes/haiku-atelier-2024/taxonomy-product_cat.php b/web/app/themes/haiku-atelier-2024/taxonomy-product_cat.php index 2d0fa317..1e61c152 100755 --- a/web/app/themes/haiku-atelier-2024/taxonomy-product_cat.php +++ b/web/app/themes/haiku-atelier-2024/taxonomy-product_cat.php @@ -37,6 +37,7 @@ $products = wc_get_products([ ]) |> function (/** @var list|stdClass */ mixed $products): array { assert(is_array($products), 'Les Produits de la Catégorie doivent être un tableau.'); + return $products; } |> (static fn(/** @var list */ array $products): array => Arr::map( diff --git a/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-completed-order.php b/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-completed-order.php index 61fbe911..db6b572b 100755 --- a/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-completed-order.php +++ b/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-completed-order.php @@ -12,7 +12,7 @@ use Illuminate\Support\Str; use Timber\Timber; if (!defined('ABSPATH')) { - exit(); + exit(); } // Initialise Timber @@ -30,13 +30,13 @@ $commande = $order; $date = new Carbon($commande->get_date_created()); $email = [ - 'commande' => ['date' => $date->toDateString(), 'id' => $commande->get_id()], - 'livraison' => [ - 'transporteur' => Str::of($commande->get_shipping_method())->replace(' (Free)', ''), - 'numero_suivi' => blank($commande->get_meta('tracking_number')) - ? 'UNKNOWN_TRACKING_NUMBER' - : $commande->get_meta('tracking_number'), - ], + 'commande' => ['date' => $date->toDateString(), 'id' => $commande->get_id()], + 'livraison' => [ + 'transporteur' => Str::of($commande->get_shipping_method())->replace(' (Free)', ''), + 'numero_suivi' => blank($commande->get_meta('tracking_number')) + ? 'UNKNOWN_TRACKING_NUMBER' + : $commande->get_meta('tracking_number'), + ], ]; $context['commande'] = $email; diff --git a/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-invoice.php b/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-invoice.php index cbdcd419..cd2e6b05 100755 --- a/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-invoice.php +++ b/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-invoice.php @@ -13,7 +13,7 @@ use Illuminate\Support\Str; use Timber\Timber; if (!defined('ABSPATH')) { - exit(); + exit(); } // Initialise Timber @@ -31,44 +31,49 @@ $commande = $order; $date = new Carbon($commande->get_date_created()); $email = [ - 'adresses' => ['facturation' => $commande->get_address('billing'), 'livraison' => $commande->get_address('shipping')], - 'commande' => ['date' => $date->toDateString(), 'id' => $commande->get_id()], - 'livraison' => [ - 'methode' => $commande->get_shipping_method(), - 'numero_suivi' => $commande->get_meta('tracking_number'), - ], - 'paiement' => ['methode' => ''], - 'produits' => collect($commande->get_items())->map(static function (WC_Order_Item_Product $article) { - $produit = $article->get_product(); + 'adresses' => [ + 'facturation' => $commande->get_address('billing'), + 'livraison' => $commande->get_address('shipping'), + ], + 'commande' => ['date' => $date->toDateString(), 'id' => $commande->get_id()], + 'livraison' => [ + 'methode' => $commande->get_shipping_method(), + 'numero_suivi' => $commande->get_meta('tracking_number'), + ], + 'paiement' => ['methode' => ''], + 'produits' => collect($commande->get_items())->map(static function (WC_Order_Item_Product $article) { + $produit = $article->get_product(); - if (is_bool($produit) || $produit === null) { - return []; - } + if (is_bool($produit) || $produit === null) { + return []; + } - return [ - // Récupère l'Attribut d'un Produit variable ou renvoie un tableau vide - 'attribut' => $produit->is_type('variable') - ? collect($produit->get_attributes()) - ->mapWithKeys(static fn($_atr, $cle): array => [ - 'nom' => Str::lower(wc_attribute_label($cle, $produit)), - 'valeur' => $produit->get_attribute($cle), - ]) - ->toArray() - : [], - 'lien' => $produit->get_permalink(), - 'nom' => $produit->get_title(), - 'prix_total' => $article->get_total(), - 'quantite' => $article->get_quantity(), - ]; - }), - 'totaux' => [ - 'sous_total_livraison' => '0' === $commande->get_shipping_total() ? 'Free' : $commande->get_shipping_total() . '€', - 'sous_total_produits' => $commande->get_subtotal() . '€', - 'sous_total_reduction' => '0.00' === $commande->get_discount_total() - ? '0' - : Number::format((float) $commande->get_discount_total(), maxPrecision: 2) . '€', - 'total' => Number::format((float) $commande->get_total(), maxPrecision: 2) . '€', - ], + return [ + // Récupère l'Attribut d'un Produit variable ou renvoie un tableau vide + 'attribut' => $produit->is_type('variable') + ? collect($produit->get_attributes()) + ->mapWithKeys(static fn($_atr, $cle): array => [ + 'nom' => Str::lower(wc_attribute_label($cle, $produit)), + 'valeur' => $produit->get_attribute($cle), + ]) + ->toArray() + : [], + 'lien' => $produit->get_permalink(), + 'nom' => $produit->get_title(), + 'prix_total' => $article->get_total(), + 'quantite' => $article->get_quantity(), + ]; + }), + 'totaux' => [ + 'sous_total_livraison' => '0' === $commande->get_shipping_total() + ? 'Free' + : $commande->get_shipping_total() . '€', + 'sous_total_produits' => $commande->get_subtotal() . '€', + 'sous_total_reduction' => '0.00' === $commande->get_discount_total() + ? '0' + : Number::format((float) $commande->get_discount_total(), maxPrecision: 2) . '€', + 'total' => Number::format((float) $commande->get_total(), maxPrecision: 2) . '€', + ], ]; // Transforme les codes de pays en noms de pays $email['adresses']['livraison']['country'] = WC()->countries->countries[$commande->get_shipping_country()]; diff --git a/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-processing-order.php b/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-processing-order.php index 830883aa..ec64d829 100755 --- a/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-processing-order.php +++ b/web/app/themes/haiku-atelier-2024/woocommerce/emails/customer-processing-order.php @@ -13,7 +13,7 @@ use Illuminate\Support\Str; use Timber\Timber; if (!defined('ABSPATH')) { - exit(); + exit(); } // Initialise Timber @@ -31,40 +31,45 @@ $commande = $order; $date = new Carbon($commande->get_date_created()); $email = [ - 'adresses' => ['facturation' => $commande->get_address('billing'), 'livraison' => $commande->get_address('shipping')], - 'commande' => ['date' => $date->toDateString(), 'id' => $commande->get_id()], - 'paiement' => ['methode' => ''], - 'produits' => collect($commande->get_items())->map(static function (WC_Order_Item_Product $article) { - $produit = $article->get_product(); + 'adresses' => [ + 'facturation' => $commande->get_address('billing'), + 'livraison' => $commande->get_address('shipping'), + ], + 'commande' => ['date' => $date->toDateString(), 'id' => $commande->get_id()], + 'paiement' => ['methode' => ''], + 'produits' => collect($commande->get_items())->map(static function (WC_Order_Item_Product $article) { + $produit = $article->get_product(); - if (is_bool($produit) || $produit === null) { - return []; - } + if (is_bool($produit) || $produit === null) { + return []; + } - return [ - // Récupère l'Attribut d'un Produit variable ou renvoie un tableau vide - 'attribut' => $article->is_type('variable') - ? collect($produit->get_attributes()) - ->mapWithKeys(static fn($_atr, $cle): array => [ - 'nom' => Str::lower(wc_attribute_label($cle, $produit)), - 'valeur' => $produit->get_attribute($cle), - ]) - ->toArray() - : [], - 'lien' => $produit->get_permalink(), - 'nom' => $produit->get_title(), - 'prix_total' => $article->get_total(), - 'quantite' => $article->get_quantity(), - ]; - }), - 'totaux' => [ - 'sous_total_livraison' => '0' === $commande->get_shipping_total() ? 'Free' : $commande->get_shipping_total() . '€', - 'sous_total_produits' => $commande->get_subtotal() . '€', - 'sous_total_reduction' => '0.00' === $commande->get_discount_total() - ? '0' - : Number::format((float) $commande->get_discount_total(), maxPrecision: 2) . '€', - 'total' => Number::format((float) $commande->get_total(), maxPrecision: 2) . '€', - ], + return [ + // Récupère l'Attribut d'un Produit variable ou renvoie un tableau vide + 'attribut' => $article->is_type('variable') + ? collect($produit->get_attributes()) + ->mapWithKeys(static fn($_atr, $cle): array => [ + 'nom' => Str::lower(wc_attribute_label($cle, $produit)), + 'valeur' => $produit->get_attribute($cle), + ]) + ->toArray() + : [], + 'lien' => $produit->get_permalink(), + 'nom' => $produit->get_title(), + 'prix_total' => $article->get_total(), + 'quantite' => $article->get_quantity(), + ]; + }), + 'totaux' => [ + 'sous_total_livraison' => '0' === $commande->get_shipping_total() + ? 'Free' + : $commande->get_shipping_total() . '€', + 'sous_total_produits' => $commande->get_subtotal() . '€', + 'sous_total_reduction' => '0.00' === $commande->get_discount_total() + ? '0' + : Number::format((float) $commande->get_discount_total(), maxPrecision: 2) . '€', + 'total' => Number::format((float) $commande->get_total(), maxPrecision: 2) . '€', + ], ]; // Transforme les codes de pays en noms de pays $email['adresses']['livraison']['country'] = WC()->countries->countries[$commande->get_shipping_country()];